Skip to content
Damdit Docs

The damdit command

The damdit command lets you and terminal agents, such as Claude Code or Codex, work with Damdit from a terminal.

Terminal window
damdit projects
damdit summary example.com --format text

Install

Section titled “Install”

Damdit installs the command when you open an installed copy. To install or check it yourself, go to Settings → AI Tools → Command Line.

  • macOS and Linux: a small script at ~/.local/bin/damdit. No administrator password is needed. If ~/.local/bin isn’t on your PATH, Damdit shows the line to add to your shell’s profile, for example to ~/.zshrc:

    Terminal window
    export PATH="$HOME/.local/bin:$PATH"

  • Windows: damdit.cmd in %LOCALAPPDATA%\Damdit\bin, which Damdit adds to your PATH. Open a new terminal afterwards.

If the status says Points to another copy of Damdit, choose Repair.

Output

Section titled “Output”

Every command prints JSON. Add --format text for a short readable form. Errors are one JSON line on stderr with an error code, a message and an exit code.

<project> is a project’s name, address or ID. Where an audit is expected, a project means its current audit; you can also give an audit’s run ID.

Read audits

Section titled “Read audits”
Command What it does
damdit projects Your projects
damdit audits <project> A project’s audits, newest first
damdit summary <project> Score, coverage, counts, changes and the first issues. Start here.
damdit issues <project> [--severity high] [--layer SEO] [--rule seo.] Issues, most severe first
damdit occurrences <project> <issueId> Where one issue occurs
damdit finding <project> <findingId> The evidence behind one finding
damdit compare <project> What changed since the audit before
damdit compare <fromRunId> <toRunId> What changed between two audits
damdit history <issueId> An issue’s status history

Lists come in pages of 50 (up to 200 with --limit). When nextOffset isn’t null, ask again with --offset <nextOffset>.

Start an audit

Section titled “Start an audit”
Terminal window
damdit audit example.com            # waits and prints the new audit's summary
damdit audit example.com --detach   # returns the job at once
damdit job <jobId> --wait 600       # follow a job
damdit cancel <jobId>               # stop an audit you started from the command line

--target staging or --target local audits another address of the project. A timeout (--timeout, 30 minutes by default) doesn’t stop the audit; follow it with damdit job.

Only one audit of a project runs at a time. Audits started in the app or on a schedule can’t be stopped from the command line.

Check a website on your computer

Section titled “Check a website on your computer”
Terminal window
damdit check http://localhost:3000 --pages 20

Audits a website running on your computer once, before it’s deployed: localhost, *.localhost, 127.0.0.1 or [::1], any port. Nothing is saved in Damdit. --pages limits the number of pages (20 by default, at most 100); --out report.json saves the full report. Checks that depend on the live host are listed as not applicable. See Local.

Change things

Section titled “Change things”
Command What it does
damdit set-status <issueId> <open|closed|not_relevant> [--note "…"] [--reason falsePositive] Set an issue’s status
damdit project create --name "Acme" --production https://acme.com [--staging …] [--local …] Create a project
damdit report <project> [--audience client|developer|ai] [--file-format markdown|pdf|html] Create a report, listed in the audit’s Reports
damdit export-data Export all data, as in Settings → Privacy & Data

Reasons for Not relevant are acceptedRisk, falsePositive, outsideScope, thirdPartyControlled, temporaryException and custom.

Other commands

Section titled “Other commands”
Command What it does
damdit status Whether Damdit is ready and what is running
damdit diagnostics Versions, AI Tools switches and the latest audits, for troubleshooting
damdit contract The methodology versions
damdit version The command’s version
damdit help [command] Help for a command
damdit mcp Runs the MCP server. See MCP.

Exit codes

Section titled “Exit codes”
Code Meaning Error codes
0 Success
1 Failure project_exists, audit_failed, audit_timeout, revision_conflict, internal, …
2 Usage usage, ambiguous_project
3 Damdit isn’t available runner_unavailable, runner_updating, …
4 Not found not_found, project_not_found, not_comparable
5 An audit of this project is already running audit_already_running
6 Not allowed api_disabled, ai_audit_start_disabled, ai_issue_changes_disabled, review_required, licence_required, not_permitted
7 Nothing responds at the address of damdit check nothing_responds
  • 3: open Damdit, or turn on background audits.
  • 6 review_required: run the project’s first audit in the app and start it after reviewing the plan.
  • 6 api_disabled: the command is turned off in Settings → AI Tools.