@codacy/verity-cli 0.20.0

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 ADDED
@@ -0,0 +1,87 @@
1
+ # @codacy/verity-cli
2
+
3
+ CLI for [Verity](https://verity.md) — a compounding quality system for AI-generated code.
4
+
5
+ ## Install
6
+
7
+ ```bash
8
+ npm install -g @codacy/verity-cli
9
+ cd your-project
10
+ verity init
11
+ ```
12
+
13
+ Then open the project in Claude Code and run `/verity-setup`.
14
+
15
+ ### Permission denied?
16
+
17
+ If `npm install -g` fails with `EACCES`, your npm global directory needs fixing:
18
+
19
+ ```bash
20
+ mkdir -p ~/.npm-global
21
+ npm config set prefix ~/.npm-global
22
+ echo 'export PATH=~/.npm-global/bin:$PATH' >> ~/.zshrc # or ~/.bashrc
23
+ source ~/.zshrc
24
+ npm install -g @codacy/verity-cli
25
+ ```
26
+
27
+ ## Upgrade to v0.16.0
28
+
29
+ ```bash
30
+ npm install -g @codacy/verity-cli@latest
31
+ ```
32
+
33
+ Existing projects work without changes. New compound features (knowledge extraction, graph memory, pre-work injection) activate automatically. Run `/verity-setup` again to add the CLAUDE.md knowledge base pointer and reflection instructions.
34
+
35
+ ## Quick reference
36
+
37
+ | Command | Description |
38
+ |---------|-------------|
39
+ | **Core** | |
40
+ | `verity init` | Initialize Verity in current project |
41
+ | `verity analyze` | Run analysis on changed files (stop hook) |
42
+ | `verity analyze --mode <mode>` | Force analysis mode (standard/plan/debug/skip) |
43
+ | `verity review --files <paths>` | On-demand analysis (advisory) |
44
+ | `verity status` | Show project quality status |
45
+ | `verity status --history` | Show recent run history with findings summary |
46
+ | `verity run <run-id>` | Show findings for a specific past run; `--json` for machine-readable output |
47
+ | **Auth & Config** | |
48
+ | `verity auth register` | Register a project |
49
+ | `verity hooks install` | Wire Claude Code hooks |
50
+ | `verity standard push` | Upload project Standard |
51
+ | **Knowledge** | |
52
+ | `verity reflect` | Trigger knowledge extraction for current task |
53
+ | `verity reflect --user-input "..."` | Save a human reflection as a knowledge node |
54
+ | `verity reflect --kind decision` | Specify the node kind |
55
+ | **Feedback** | |
56
+ | `verity feedback message "text"` | Send general feedback |
57
+ | `verity feedback finding <run-id> <pattern-id> <action>` | Per-finding feedback |
58
+ | **Tasks** | |
59
+ | `verity task list` | List tasks |
60
+ | `verity task close` | Close the current task (triggers extraction) |
61
+
62
+ ## Skills (Claude Code)
63
+
64
+ | Skill | Description |
65
+ |-------|-------------|
66
+ | `/verity-setup` | Project configuration wizard |
67
+ | `/verity-analyze` | On-demand analysis |
68
+ | `/verity-status` | Project health dashboard |
69
+ | `/verity-feedback` | Feedback (general + per-finding) |
70
+ | `/verity-learn` | View and manage project knowledge |
71
+ | `/verity-memory` | Browse the knowledge graph |
72
+ | `/verity-insights` | Quality metrics + Standard evolution |
73
+ | `/verity-reflect` | Capture learnings after a task |
74
+
75
+ ## How it works
76
+
77
+ ```
78
+ Prompt → inject knowledge → Agent works → verity analyze → reviewer + knowledge → PASS/FAIL
79
+
80
+ extract learnings → .verity/memory/ (graph)
81
+
82
+ next prompt starts smarter
83
+ ```
84
+
85
+ The quality gate catches problems. The knowledge system prevents them from recurring. Every analysis run teaches the next one.
86
+
87
+ Requires Node.js 20+.