@legacycodehq/clarity 0.13.3 → 0.15.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.
Files changed (2) hide show
  1. package/README.md +25 -19
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -27,7 +27,7 @@ brew install LegacyCodeHQ/tap/clarity
27
27
  **Step 2:** Inside your project:
28
28
 
29
29
  ```bash
30
- clarity setup # Add usage instructions to AGENTS.md for your coding agent
30
+ clarity setup # Adds usage instructions to AGENTS.md for your coding agent
31
31
  ```
32
32
 
33
33
  More install options: [Installation Guide](docs/usage/installation.md).
@@ -55,31 +55,37 @@ More install options: [Installation Guide](docs/usage/installation.md).
55
55
  - [Audit AI-generated code](https://youtu.be/EqOwJnZSiQs)
56
56
  - Stabilize and reclaim apps built with AI
57
57
 
58
- ## Problems
58
+ ## Manual Usage
59
59
 
60
- Every time a coding agent makes changes to your codebase, you have the following questions:
60
+ If you run `clarity setup`, your coding agent will use Clarity automatically from `AGENTS.md`.
61
61
 
62
- - Which files should I review first and in what order?
63
- - Where should I spend most of my review effort?
64
- - What is the blast radius of this change?
65
- - Which parts of the change are too risky?
66
- - How does this solution fit into the existing system?
67
- - Are there adequate tests for these changes?
62
+ If you want to use Clarity manually in your terminal, use `clarity show` commands like the examples below.
68
63
 
69
- These concerns worsen when there are:
64
+ ### Common Commands
70
65
 
71
- - Too many files to review
72
- - You have an outdated mental model of your codebase
66
+ ```bash
67
+ clarity show # Visualize uncommitted changes
68
+ clarity show -c HEAD # Visualize the latest commit
69
+ clarity show -c HEAD~3...HEAD # Visualize a commit range
70
+ clarity show -i src,tests # Build graph from specific files/directories
71
+ clarity show -w a.go,b.go # Show all paths between files
72
+ clarity show -f mermaid # Mermaid output (default is dot)
73
+ clarity show -u # Generate a shareable visualization URL
74
+ clarity languages # List supported languages and extensions
75
+ ```
76
+
77
+ > Note: For quick viewing and sharing, run `clarity show -u` to generate a visualization URL directly.
78
+
79
+ ### Output Options
73
80
 
74
- ## How Clarity Helps
81
+ - `-f dot`: Graphviz DOT output (default)
82
+ - `-f mermaid`: Mermaid flowchart output
83
+ - `-u`: Generate a visualization URL for supported formats
75
84
 
76
- Clarity uses a file-based dependency graph to visualize the impact of AI-generated changes, showing you:
85
+ ### Tips
77
86
 
78
- - The files changed and the relationships between them
79
- - The order to review files (**short answer:** review from right-to-left)
80
- - Color-coded files by extension to help you quickly categorize and group them for review
81
- - Test files at a glance
82
- - An accurate mental model of the system as you evolve it
87
+ - Run `clarity show` after every non-trivial code change to review blast radius.
88
+ - Use `clarity show -c <commit>` for clean, reproducible review snapshots.
83
89
 
84
90
  ## Clarity in Action
85
91
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@legacycodehq/clarity",
3
- "version": "0.13.3",
3
+ "version": "0.15.0",
4
4
  "description": "Clarity CLI npm wrapper package",
5
5
  "license": "AGPL-3.0-only",
6
6
  "homepage": "https://github.com/LegacyCodeHQ/clarity",