@archpilotlabs/archpilot 0.0.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/LICENSE +9 -0
- package/README.md +168 -0
- package/dist/archpilot-cli.js +236574 -0
- package/package.json +24 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
Copyright (c) 2026 ArchPilotLabs
|
|
2
|
+
|
|
3
|
+
All rights reserved.
|
|
4
|
+
|
|
5
|
+
This software and associated documentation files (the "Software") are proprietary and confidential.
|
|
6
|
+
|
|
7
|
+
No part of this Software may be used, copied, modified, distributed, sublicensed, or disclosed without prior written permission from ArchPilotLabs.
|
|
8
|
+
|
|
9
|
+
For licensing inquiries, contact: support@archpilot.org
|
package/README.md
ADDED
|
@@ -0,0 +1,168 @@
|
|
|
1
|
+
# ArchPilot
|
|
2
|
+
|
|
3
|
+
**Executable architecture governance for your codebase.**
|
|
4
|
+
|
|
5
|
+
ArchPilot is a CLI that validates your repository against architecture rules and helps you keep your system **visible, enforceable, and measurable** as it evolves.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## 🚀 What it does
|
|
10
|
+
|
|
11
|
+
ArchPilot turns architecture into something you can actually run and verify:
|
|
12
|
+
|
|
13
|
+
* Validate module boundaries and dependencies
|
|
14
|
+
* Enforce architecture rules and contracts
|
|
15
|
+
* Detect architectural drift over time
|
|
16
|
+
* Generate architecture scores and reports
|
|
17
|
+
* Surface architecture feedback in PRs and CI
|
|
18
|
+
|
|
19
|
+
No runtime agents. No external services. Fully deterministic and local-first.
|
|
20
|
+
|
|
21
|
+
---
|
|
22
|
+
|
|
23
|
+
## 📦 Installation
|
|
24
|
+
|
|
25
|
+
Install globally:
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
npm install -g @archpilotlabs/archpilot
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
Or run without installing:
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
npx @archpilotlabs/archpilot --help
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
---
|
|
38
|
+
|
|
39
|
+
## ⚡ Quick Start
|
|
40
|
+
|
|
41
|
+
### 1. Initialize architecture
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
archpilot init
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
Creates `.archpilot/` with architecture config, rules, and baseline artifacts.
|
|
48
|
+
|
|
49
|
+
---
|
|
50
|
+
|
|
51
|
+
### 2. Run validation
|
|
52
|
+
|
|
53
|
+
```bash
|
|
54
|
+
archpilot validate
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
Example output:
|
|
58
|
+
|
|
59
|
+
```text
|
|
60
|
+
ArchPilot Architecture Review
|
|
61
|
+
|
|
62
|
+
Result: FAIL
|
|
63
|
+
Errors: 2 Warnings: 1
|
|
64
|
+
Score: 82 / 100
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
---
|
|
68
|
+
|
|
69
|
+
### 3. Fix issues
|
|
70
|
+
|
|
71
|
+
```bash
|
|
72
|
+
archpilot fix
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
Applies safe, deterministic fixes for missing architecture artifacts.
|
|
76
|
+
|
|
77
|
+
---
|
|
78
|
+
|
|
79
|
+
### 4. Use in CI
|
|
80
|
+
|
|
81
|
+
```bash
|
|
82
|
+
archpilot validate --ci
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
* Fails only on real architecture violations
|
|
86
|
+
* Keeps setup issues separate from architecture quality
|
|
87
|
+
|
|
88
|
+
---
|
|
89
|
+
|
|
90
|
+
## 🧑💻 CLI vs VS Code Extension
|
|
91
|
+
|
|
92
|
+
ArchPilot works in two ways:
|
|
93
|
+
|
|
94
|
+
* **CLI (this package)** → validation, CI, automation
|
|
95
|
+
* **VS Code Extension** → visual inspector, guided workflows, and architecture exploration
|
|
96
|
+
|
|
97
|
+
Both use the same validation engine and produce identical results.
|
|
98
|
+
The extension enhances developer experience, but is not required.
|
|
99
|
+
|
|
100
|
+
---
|
|
101
|
+
|
|
102
|
+
## 🧠 Key Concepts
|
|
103
|
+
|
|
104
|
+
### Architecture Health Score
|
|
105
|
+
|
|
106
|
+
Measures actual architecture quality based on violations.
|
|
107
|
+
|
|
108
|
+
### Setup Readiness Score
|
|
109
|
+
|
|
110
|
+
Tracks completeness of configuration and onboarding.
|
|
111
|
+
|
|
112
|
+
### Findings
|
|
113
|
+
|
|
114
|
+
* **violation** → real architecture issue
|
|
115
|
+
* **setup-gap** → missing config / skipped checks
|
|
116
|
+
* **guidance** → non-blocking recommendation
|
|
117
|
+
|
|
118
|
+
---
|
|
119
|
+
|
|
120
|
+
## 🔍 Core Commands
|
|
121
|
+
|
|
122
|
+
```bash
|
|
123
|
+
archpilot init
|
|
124
|
+
archpilot validate
|
|
125
|
+
archpilot validate --ci
|
|
126
|
+
archpilot fix
|
|
127
|
+
archpilot impact <file>
|
|
128
|
+
archpilot review pr
|
|
129
|
+
archpilot diagrams generate
|
|
130
|
+
archpilot governance upload
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
---
|
|
134
|
+
|
|
135
|
+
## 🧩 Features
|
|
136
|
+
|
|
137
|
+
* Architecture-as-code (`.archpilot/`)
|
|
138
|
+
* Dependency validation and module contracts
|
|
139
|
+
* ADR (Architecture Decision Record) support
|
|
140
|
+
* Drift detection and history tracking
|
|
141
|
+
* PR review and CI integration
|
|
142
|
+
* Architecture scoring and reporting
|
|
143
|
+
|
|
144
|
+
---
|
|
145
|
+
|
|
146
|
+
## 🎯 Philosophy
|
|
147
|
+
|
|
148
|
+
ArchPilot is built on four principles:
|
|
149
|
+
|
|
150
|
+
* Architecture should be explicit
|
|
151
|
+
* Rules should be executable
|
|
152
|
+
* Validation should be deterministic
|
|
153
|
+
* Feedback should be continuous
|
|
154
|
+
|
|
155
|
+
---
|
|
156
|
+
|
|
157
|
+
## 📄 License
|
|
158
|
+
|
|
159
|
+
All rights reserved. This software is proprietary and closed-source.
|
|
160
|
+
|
|
161
|
+
---
|
|
162
|
+
|
|
163
|
+
## 🌐 Learn More
|
|
164
|
+
|
|
165
|
+
* Website: https://archpilot.org
|
|
166
|
+
* Documentation: https://archpilot.org/docs
|
|
167
|
+
|
|
168
|
+
---
|