@rsdoctor/agent-cli
v0.1.0
Published
`@rsdoctor/agent-cli` is a small command-line tool for reading Rsdoctor analysis data and exposing it as structured JSON.
Downloads
38,362
Readme
@rsdoctor/agent-cli
@rsdoctor/agent-cli is a small command-line tool for reading Rsdoctor analysis data and exposing it as structured JSON.
It is intended to be used together with the rsdoctor-analysis skill from agent-skills. Trigger that skill first, then use this CLI to inspect the generated Rsdoctor data.
To add the skill locally:
npx skills add rstackjs/agent-skills --skill rsdoctor-analysisIt provides two ways to work with the catalog:
listandqueryfor machine-oriented access.- Direct group commands such as
chunks list,modules by-id, andtree-shaking summaryfor interactive use.
Installation
pnpm add -D @rsdoctor/agent-cliThe package exposes a binary named rsdoctor-agent.
Usage
rsdoctor-agent --help
rsdoctor-agent list
rsdoctor-agent query <tool-name> --data-file <path>
rsdoctor-agent <group> <subcommand> --data-file <path>Top-level commands
list
Prints all available subcommands in machine-readable JSON, including their descriptions and argument schemas.
rsdoctor-agent listquery
Executes one catalog tool by name and returns the result as JSON.
rsdoctor-agent query packages_duplicates \
--data-file ./rsdoctor-data.json \
--input '{"includeDev":true}' \
--filter rule,totalRules \
--page 1 \
--page-size 20Useful options:
--data-file <path>: path to the Rsdoctor data file.--input <json>: tool input payload, defaulting to{}.--filter <fields>: comma-separated field paths to keep in the output.--page <n>: page number for paginated results.--page-size <n>: page size for paginated results.
Direct commands
If you want to inspect a specific area of the report, you can call the grouped commands directly.
Examples:
rsdoctor-agent chunks list --data-file ./rsdoctor-data.json
rsdoctor-agent modules by-id --data-file ./rsdoctor-data.json --id 42
rsdoctor-agent packages list --data-file ./rsdoctor-data.json --page-number 1 --page-size 50
rsdoctor-agent tree-shaking summary --data-file ./rsdoctor-data.jsonYou can also inspect schemas and command descriptions:
rsdoctor-agent --describe
rsdoctor-agent --schema chunks.list
rsdoctor-agent chunks --describeOutput
- Successful commands print JSON to stdout.
- Errors are printed to stderr and the process exits with a non-zero code.
- The
--compactflag prints minified JSON for commands that support it.
Development
pnpm install
pnpm --filter @rsdoctor/agent-cli run build
pnpm --filter @rsdoctor/agent-cli run testRepository
This package lives in the packages/agent-cli workspace and is part of the Rsdoctor monorepo.
