@promptci/cli 0.1.0 → 0.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -3
- package/dist/cli.cjs +146 -120
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
# @promptci/cli
|
|
2
2
|
|
|
3
3
|
Instruction health for AI coding workflows. Scans AI coding instruction files
|
|
4
|
-
(`CLAUDE.md`, `AGENTS.md`, `.cursorrules`, Copilot instructions,
|
|
4
|
+
(`CLAUDE.md`, `AGENTS.md`, `.cursorrules`, Copilot instructions, `GEMINI.md`, Cline rules, and
|
|
5
|
+
more) and produces
|
|
5
6
|
actionable health reports: duplicates, conflicting directives, stale guidance, context bloat,
|
|
6
7
|
broken references, and vague instructions.
|
|
7
8
|
|
|
@@ -11,10 +12,14 @@ output for identical input.
|
|
|
11
12
|
## Usage
|
|
12
13
|
|
|
13
14
|
```bash
|
|
14
|
-
npx @promptci/cli
|
|
15
|
+
npx @promptci/cli # quick score + top 3 findings: no account, no network, writes nothing
|
|
16
|
+
npx @promptci/cli scan # full scan and reports
|
|
15
17
|
```
|
|
16
18
|
|
|
17
|
-
|
|
19
|
+
The no-argument form is `promptci score`; see the
|
|
20
|
+
[main README](https://github.com/SeriousGeese/PromptCI#quickstart) for sample output.
|
|
21
|
+
|
|
22
|
+
`scan` writes `.promptci/latest.md` (human-readable) and `.promptci/report.json` (machine-readable),
|
|
18
23
|
and prints a summary with a health score and top fixes.
|
|
19
24
|
|
|
20
25
|
Common commands:
|
|
@@ -24,6 +29,7 @@ npx @promptci/cli scan --path /path/to/repo # scan a specific repo
|
|
|
24
29
|
npx @promptci/cli init # create .promptci/config.json
|
|
25
30
|
npx @promptci/cli fix # apply deterministic fix recipes
|
|
26
31
|
npx @promptci/cli review-diff --base origin/main # CI: fail on instruction regressions
|
|
32
|
+
npx @promptci/cli badge # write a Shields.io JSON for a README score badge
|
|
27
33
|
```
|
|
28
34
|
|
|
29
35
|
Full documentation: https://github.com/SeriousGeese/PromptCI
|