@eddacraft/anvil-cli 0.1.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,67 @@
1
+ # Anvil
2
+
3
+ Deterministic development automation that makes AI-generated code changes safe
4
+ for production. Validate plans through quality gates before execution, ensuring
5
+ changes meet your team's standards.
6
+
7
+ ## Quick Start
8
+
9
+ ```bash
10
+ # Try without installing
11
+ npx @eddacraft/anvil-cli tutorial
12
+
13
+ # Or install globally
14
+ npm install -g @eddacraft/anvil-cli
15
+ anvil tutorial
16
+ ```
17
+
18
+ The interactive tutorial takes about 5 minutes and walks you through scanning,
19
+ watching, and fixing issues.
20
+
21
+ ## What Anvil Does
22
+
23
+ - **Quality gates** - validate code changes against architecture rules,
24
+ anti-patterns, and team conventions
25
+ - **Plan validation** - check planning documents (APS, SpecKit, BMAD) before
26
+ execution
27
+ - **Architecture enforcement** - define boundaries, layers, and dependency rules
28
+ - **Real-time watch mode** - validate as you code with instant feedback
29
+ - **AI authorship tracking** - trace which changes were AI-generated via Git
30
+ Notes
31
+ - **OPA/Rego policies** - write custom rules for your organisation
32
+
33
+ ## Commands
34
+
35
+ | Command | Description |
36
+ | ---------------------- | ------------------------------- |
37
+ | `anvil tutorial` | Interactive guided tutorial |
38
+ | `anvil init` | Set up Anvil in a project |
39
+ | `anvil check --all` | Scan codebase for issues |
40
+ | `anvil watch --source` | Real-time validation |
41
+ | `anvil gate` | Run quality gates |
42
+ | `anvil doctor` | Diagnostics and troubleshooting |
43
+ | `anvil explain <rule>` | Understand a warning |
44
+ | `anvil status` | Show workspace status |
45
+ | `anvil --help` | See all commands |
46
+
47
+ ## Requirements
48
+
49
+ - Node.js 20.0.0 or later
50
+ - Git
51
+
52
+ ## Beta
53
+
54
+ This is `v0.1.0` - an early beta release. We welcome bug reports and feedback:
55
+
56
+ - [Report a bug](https://github.com/EddaCraft/anvil-001/issues/new?template=bug_report.md)
57
+ - [Request a feature](https://github.com/EddaCraft/anvil-001/issues/new?template=feature_request.md)
58
+ - [Share feedback](https://github.com/EddaCraft/anvil-001/issues/new?template=feedback.md)
59
+
60
+ ## Documentation
61
+
62
+ - [Beta Tester Quickstart](https://github.com/EddaCraft/anvil-001/blob/main/docs/beta-testers/BETA-TESTER-QUICKSTART.md)
63
+ - [CLI Command Reference](https://github.com/EddaCraft/anvil-001/blob/main/apps/anvil-cli/DEVELOPMENT.md)
64
+
65
+ ## Licence
66
+
67
+ Apache-2.0