ai-development-protocol 1.0.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/LICENSE +21 -0
- package/README.md +88 -0
- package/agent.md +1083 -0
- package/dist/cli.js +1163 -0
- package/dist/cli.js.map +1 -0
- package/dist/index.js +1192 -0
- package/dist/index.js.map +1 -0
- package/package.json +40 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
# AI Project Development Protocol (AIDP)
|
|
2
|
+
|
|
3
|
+
A tool-agnostic protocol and CLI for collaborative software engineering between developers and AI coding agents.
|
|
4
|
+
|
|
5
|
+
Based on the [AI Project Development Protocol specification](./agent.md).
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Features
|
|
10
|
+
|
|
11
|
+
- **Protocol Scaffolding (`aidp init`)**: Initializes the standard `.ai/` directory structure, context files, and lifecycle directories.
|
|
12
|
+
- **Protocol Validation (`aidp validate`)**: Verifies that the `.ai/` knowledge base strictly conforms to the protocol structure.
|
|
13
|
+
- **Project Dashboard (`aidp status`)**: Displays current project phase, goals, active/planned tasks, ADRs, and open discovery questions.
|
|
14
|
+
- **ADR Management (`aidp adr`)**: Creates sequentially numbered Architecture Decision Records (`0001-...md`) and synchronizes them into `architecture.md`.
|
|
15
|
+
- **Task Lifecycle (`aidp task`)**: Tracks actionable tasks through `planned/`, `active/`, and `completed/` stages.
|
|
16
|
+
- **Requirements Discovery (`aidp question`)**: Manages the open questions queue in `requirements.md`.
|
|
17
|
+
- **Zero Runtime Dependencies**: Written in modern TypeScript using native Node.js type stripping and Node's built-in test runner.
|
|
18
|
+
|
|
19
|
+
---
|
|
20
|
+
|
|
21
|
+
## Directory Structure
|
|
22
|
+
|
|
23
|
+
\`\`\`text
|
|
24
|
+
.ai/
|
|
25
|
+
├── README.md # Living knowledge base guide
|
|
26
|
+
├── context/ # Authoritative system context
|
|
27
|
+
│ ├── project.md # Identity, scope, state, and goals
|
|
28
|
+
│ ├── requirements.md # Requirements, assumptions, and open questions
|
|
29
|
+
│ ├── architecture.md # System structure, components, boundaries
|
|
30
|
+
│ ├── development.md # Conventions, workflows, testing rules
|
|
31
|
+
│ └── operations.md # Deployment, environments, runbooks
|
|
32
|
+
├── decisions/ # Architecture Decision Records (ADRs)
|
|
33
|
+
├── tasks/ # Actionable work breakdown
|
|
34
|
+
│ ├── planned/ # Ready to be started
|
|
35
|
+
│ ├── active/ # Currently in progress
|
|
36
|
+
│ └── completed/ # Done and validated
|
|
37
|
+
└── reports/ # Periodic evaluation records
|
|
38
|
+
├── reviews/ # Code and design reviews
|
|
39
|
+
├── security/ # Security audits
|
|
40
|
+
└── testing/ # Test summaries
|
|
41
|
+
\`\`\`
|
|
42
|
+
|
|
43
|
+
---
|
|
44
|
+
|
|
45
|
+
## CLI Usage
|
|
46
|
+
|
|
47
|
+
### 1. Initialize Protocol
|
|
48
|
+
\`\`\`bash
|
|
49
|
+
npm run aidp -- init [path] --name "My Project"
|
|
50
|
+
\`\`\`
|
|
51
|
+
|
|
52
|
+
### 2. View Project Status
|
|
53
|
+
\`\`\`bash
|
|
54
|
+
npm run aidp -- status
|
|
55
|
+
\`\`\`
|
|
56
|
+
|
|
57
|
+
### 3. Record an Architectural Decision
|
|
58
|
+
\`\`\`bash
|
|
59
|
+
npm run aidp -- adr new "Adopt PostgreSQL For Persistence" --status Accepted
|
|
60
|
+
npm run aidp -- adr list
|
|
61
|
+
\`\`\`
|
|
62
|
+
|
|
63
|
+
### 4. Manage Tasks
|
|
64
|
+
\`\`\`bash
|
|
65
|
+
npm run aidp -- task new "Setup Database Migrations" --active
|
|
66
|
+
npm run aidp -- task move TASK-0001 completed
|
|
67
|
+
npm run aidp -- task list
|
|
68
|
+
\`\`\`
|
|
69
|
+
|
|
70
|
+
### 5. Track Open Questions
|
|
71
|
+
\`\`\`bash
|
|
72
|
+
npm run aidp -- question add "Will authentication be required for the MVP?"
|
|
73
|
+
npm run aidp -- question list
|
|
74
|
+
\`\`\`
|
|
75
|
+
|
|
76
|
+
### 6. Validate Protocol Compliance
|
|
77
|
+
\`\`\`bash
|
|
78
|
+
npm run aidp -- validate
|
|
79
|
+
\`\`\`
|
|
80
|
+
|
|
81
|
+
---
|
|
82
|
+
|
|
83
|
+
## Testing
|
|
84
|
+
|
|
85
|
+
Run the automated test suite:
|
|
86
|
+
\`\`\`bash
|
|
87
|
+
npm test
|
|
88
|
+
\`\`\`
|