explaingit

danilaa1/auditkit

21RustAudience · ops devopsComplexity · 3/5Setup · moderate

TLDR

A command-line tool for freelancers and agencies that audits any website for SEO problems, missing security headers, and performance issues, then saves findings as readable markdown reports.

Mindmap

mindmap
  root((auditkit))
    What it does
      Audit client websites
      Generate markdown reports
      Draft client emails
    Tech Stack
      Rust core
      Node.js for Lighthouse
      Chrome browser required
    Checks run
      HTML and SEO basics
      Security headers
      Lighthouse performance
    Workflows
      Quick single check
      Full client workspace
      Standalone commands
Click or tap to explore — scroll the page freely

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

Things people build with this

USE CASE 1

Run a full website audit for a client and get SEO issues, security header gaps, and Lighthouse scores saved as markdown files with one command.

USE CASE 2

Create a named workspace per client, run all checks inside it, and generate a summary report plus a draft follow-up email ready to send.

USE CASE 3

Check a site's HTTP security response headers independently to spot missing headers before presenting findings to a client.

Tech stack

RustNode.jsLighthouseChrome

Getting it running

Difficulty · moderate Time to first run · 30min

Requires Node.js for Lighthouse and a Chromium-family browser installed on the same machine.

In plain English

Audit Kit is a command-line tool for freelancers and agencies who need to audit client websites. You give it a URL, and it runs a set of automated checks covering HTML and SEO basics, security headers, and a performance analysis powered by Google's Lighthouse tool. The results are saved as readable markdown files in a folder of your choosing. The core of the tool is written in Rust, which handles HTML fetching, audit logic, and report writing. Node.js is included only to run Lighthouse, which requires a browser (Chrome, Chromium, Brave, or Edge) to be installed on the same machine. The simplest workflow is a single command, ak check, which prompts you for the site URL, runs the checks, and asks where to save the output. For client work, a fuller workflow is available: ak new creates a named workspace folder for the client, ak inspect runs all automated checks inside that workspace, and ak report generates a summary of findings along with a draft client email, all as markdown files organized in one directory. Individual commands can also be run standalone. The security command checks HTTP response headers. The lighthouse command runs the Lighthouse performance and accessibility scan and saves both a markdown summary and the raw JSON output. Each command accepts a save flag so you can drop results wherever your workflow expects them. The tool installs via npm or Bun, and architecture notes for developers are kept in a separate docs file in the repository.

Copy-paste prompts

Prompt 1
I installed auditkit with npm. How do I run ak check on a client site URL and where does it save the output markdown files?
Prompt 2
Walk me through setting up a named client workspace with auditkit using ak new, then ak inspect, then ak report, and explain what files each command produces.
Prompt 3
The auditkit Lighthouse command is not finding Chrome on my machine. What browsers does it support and how do I point it to a specific browser binary?
Prompt 4
I want to add a custom audit check to auditkit in Rust. Where in the source code do the existing audit checks live and how do I add a new one?
Open on GitHub → Explain another repo

← danilaa1 on gitmyhub — every repo by this author, as a profile.

Verify against the repo before relying on details.