@rsdoctor/agent-cli - npm Package Compare versions

Comparing version 0.1.0-beta.0 to 0.1.0

README.md

+# @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](https://github.com/rstackjs/agent-skills). Trigger that skill first, then use this CLI to inspect the generated Rsdoctor data.
+
+To add the skill locally:
+
+```bash
+npx skills add rstackjs/agent-skills --skill rsdoctor-analysis
+```
+
+It provides two ways to work with the catalog:
+
+- `list` and `query` for machine-oriented access.
+- Direct group commands such as `chunks list`, `modules by-id`, and `tree-shaking summary` for interactive use.
+
+## Installation
+
+```bash
+pnpm add -D @rsdoctor/agent-cli
+```
+
+The package exposes a binary named `rsdoctor-agent`.
+
+## Usage
+
+```bash
+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.
+
+```bash
+rsdoctor-agent list
+```
+
+### `query`
+
+Executes one catalog tool by name and returns the result as JSON.
+
+```bash
+rsdoctor-agent query packages_duplicates \
+  --data-file ./rsdoctor-data.json \
+  --input '{"includeDev":true}' \
+  --filter rule,totalRules \
+  --page 1 \
+  --page-size 20
+```
+
+Useful 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:
+
+```bash
+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.json
+```
+
+You can also inspect schemas and command descriptions:
+
+```bash
+rsdoctor-agent --describe
+rsdoctor-agent --schema chunks.list
+rsdoctor-agent chunks --describe
+```
+
+## Output
+
+- Successful commands print JSON to stdout.
+- Errors are printed to stderr and the process exits with a non-zero code.
+- The `--compact` flag prints minified JSON for commands that support it.
+
+## Development
+
+```bash
+pnpm install
+pnpm --filter @rsdoctor/agent-cli run build
+pnpm --filter @rsdoctor/agent-cli run test
+```
+
+## Repository
+
+This package lives in the `packages/agent-cli` workspace and is part of the Rsdoctor monorepo.

package.json

 {
   "name": "@rsdoctor/agent-cli",
-  "version": "0.1.0-beta.0",
+  "version": "0.1.0",
   "repository": {
@@ -20,9 +20,7 @@ "type": "git",
   "type": "module",
-  "dependencies": {
-    "cac": "^7.0.0"
-  },
   "devDependencies": {
-    "@rslib/core": "0.21.2",
-    "@rstest/core": "0.9.7",
+    "@rslib/core": "0.21.3",
+    "@rstest/core": "0.9.9",
     "@types/node": "^22.8.1",
+    "cac": "^7.0.0",
     "typescript": "^5.9.2"
@@ -29,0 +27,0 @@ },

New alerts

Shell access

Supply chain risk

This module accesses the system shell. Accessing the system shell increases the risk of executing arbitrary code.

Fixed alerts

No README

Quality

Package does not have a README. This may indicate a failed publish or a low quality package.

Improved metrics

Total package byte prevSize

114012

25.13%

Dependency count

0

-100%

Number of package files

5

25%

Lines of code

2932

22.73%

Number of medium quality alerts

0

-100%

Number of lines in readme file

104

Infinity%

Worsened metrics

Dev dependency count

5

25%

Dependency changes

• - Removed

  cac@^7.0.0

• - Removed

  cac@7.0.0
  (transitive)