Docs

agentscan audits agent configuration on disk. Scans are read-only and never open a network connection. Full behavior lives in the README.

Quickstart

Run against any project. It reads that project, writes nothing, and never leaves your machine.

cd ~/your-project
npx @chimix/agentscan@latest
# or explicitly:
npx @chimix/agentscan check

bunx --bun @chimix/agentscan
# or after install:
bun add -d @chimix/agentscan
bunx agentscan check

git clone --depth=1 https://github.com/SimaAlexandru99/agentscan
cd agentscan && bun install
bun run src/cli.ts check ~/your-project

The package is scoped @chimix/agentscan because npm rejects the bare name. The command you type stays agentscan.

Flag	Meaning
--json	JSON report (alias for --output json)
--output <format>	human (default) · json · prompt
--copy	Also copy the report to the system clipboard
--no-color	Never colour, even on a terminal (NO_COLOR=1 does the same)
--quiet	Summary line only
--verbose	Show KEEP + info-severity findings
--fail-on <level>	never (default) · warning · error
--fail-under <0-100>	Fail when the score drops below this floor
--global	Also scan ~/.claude/skills and ~/.codex/skills
--config <path>	Config file path

v1 does not write the tree — no apply, no skill delete/install. Findings may suggest shell commands; you run them yourself.

The Action runs from its own checkout, so it uses the ref you pin rather than whatever is on npm:

- uses: SimaAlexandru99/agentscan@v0
  with:
    fail-on: error        # never | warning | error
    output: human         # human | json | prompt

Or run it directly:

- name: agentscan
  run: bunx agentscan check --fail-on error

Default failOn is never so local runs stay non-blocking until you opt in.