agentloopkit 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/LICENSE +21 -0
- package/README.md +240 -0
- package/dist/cli/index.d.ts +2 -0
- package/dist/cli/index.js +1144 -0
- package/dist/cli/index.js.map +1 -0
- package/dist/schema/agentloop.config.schema.json +142 -0
- package/dist/templates/agents/claude-code.md +18 -0
- package/dist/templates/agents/codex.md +27 -0
- package/dist/templates/agents/cursor.md +17 -0
- package/dist/templates/agents/gemini-cli.md +19 -0
- package/dist/templates/agents/generic.md +27 -0
- package/dist/templates/agents/github-copilot-cli.md +18 -0
- package/dist/templates/agents/opencode.md +18 -0
- package/dist/templates/gates/dependency-gate.md +24 -0
- package/dist/templates/gates/docs-gate.md +24 -0
- package/dist/templates/gates/implementation-gate.md +28 -0
- package/dist/templates/gates/regression-gate.md +25 -0
- package/dist/templates/gates/review-gate.md +24 -0
- package/dist/templates/gates/security-gate.md +26 -0
- package/dist/templates/gates/test-gate.md +24 -0
- package/dist/templates/handoffs/decision-log.md +13 -0
- package/dist/templates/handoffs/pr-summary.md +36 -0
- package/dist/templates/handoffs/release-notes.md +15 -0
- package/dist/templates/handoffs/reviewer-brief.md +13 -0
- package/dist/templates/handoffs/rollback-plan.md +11 -0
- package/dist/templates/handoffs/verification-report.md +13 -0
- package/dist/templates/harness/autonomous-work-rules.md +22 -0
- package/dist/templates/harness/commands.md +16 -0
- package/dist/templates/harness/definition-of-done.md +16 -0
- package/dist/templates/harness/release-checklist.md +11 -0
- package/dist/templates/harness/repo-map.md +16 -0
- package/dist/templates/harness/review-checklist.md +9 -0
- package/dist/templates/harness/working-agreement.md +11 -0
- package/dist/templates/loops/bugfix.md +36 -0
- package/dist/templates/loops/dependency-upgrade.md +34 -0
- package/dist/templates/loops/docs.md +35 -0
- package/dist/templates/loops/feature.md +38 -0
- package/dist/templates/loops/migration.md +35 -0
- package/dist/templates/loops/refactor.md +35 -0
- package/dist/templates/loops/release.md +35 -0
- package/dist/templates/loops/security-review.md +35 -0
- package/dist/templates/loops/test-generation.md +34 -0
- package/dist/templates/policies/database-change-policy.md +11 -0
- package/dist/templates/policies/dependency-change-policy.md +11 -0
- package/dist/templates/policies/git-policy.md +11 -0
- package/dist/templates/policies/no-destructive-actions.md +17 -0
- package/dist/templates/policies/public-api-change-policy.md +11 -0
- package/dist/templates/policies/secrets-policy.md +11 -0
- package/dist/templates/policies/security-policy.md +11 -0
- package/dist/templates/policies/ui-change-policy.md +11 -0
- package/dist/templates/root/AGENTLOOP.md +39 -0
- package/dist/templates/root/AGENTS.md +24 -0
- package/dist/templates/root/agentloop-directory-readme.md +36 -0
- package/dist/templates/root/agentloop.config.json +37 -0
- package/dist/templates/tasks/README.md +9 -0
- package/package.json +71 -0
- package/schema/agentloop.config.schema.json +142 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Abhi
|
|
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,240 @@
|
|
|
1
|
+
# AgentLoopKit
|
|
2
|
+
|
|
3
|
+
A drop-in engineering loop for coding agents.
|
|
4
|
+
|
|
5
|
+
Your coding agent can already write code. AgentLoopKit helps it work like a disciplined engineer: scoped task contracts, explicit safety rules, verification evidence, review summaries, and clean handoffs.
|
|
6
|
+
|
|
7
|
+
Vibe coding produces code. Agentic engineering produces auditable work.
|
|
8
|
+
|
|
9
|
+
## What It Is
|
|
10
|
+
|
|
11
|
+
AgentLoopKit is a repo-level toolkit for developers using Codex, Claude Code, Cursor, OpenCode, Gemini CLI, GitHub Copilot CLI, and other coding agents.
|
|
12
|
+
|
|
13
|
+
It does not replace your agent, IDE, or CLI. It gives those tools a repeatable engineering loop inside the repository they are editing.
|
|
14
|
+
|
|
15
|
+
AgentLoopKit generates:
|
|
16
|
+
|
|
17
|
+
- `AGENTS.md`
|
|
18
|
+
- `AGENTLOOP.md`
|
|
19
|
+
- `agentloop.config.json`
|
|
20
|
+
- `.agentloop/` with task templates, gates, policies, reports, handoffs, and agent instructions
|
|
21
|
+
|
|
22
|
+
## Why It Exists
|
|
23
|
+
|
|
24
|
+
Coding agents often move fast but leave reviewers with weak evidence: unclear scope, missing tests, broad diffs, and vague summaries. AgentLoopKit gives the agent a repo-local contract:
|
|
25
|
+
|
|
26
|
+
1. Specify the task.
|
|
27
|
+
2. Constrain risk.
|
|
28
|
+
3. Plan the change.
|
|
29
|
+
4. Implement the smallest useful diff.
|
|
30
|
+
5. Verify with configured commands.
|
|
31
|
+
6. Review the diff.
|
|
32
|
+
7. Handoff with evidence.
|
|
33
|
+
|
|
34
|
+
## Install
|
|
35
|
+
|
|
36
|
+
Use it with `npx` inside an existing repository:
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
npx agentloopkit init
|
|
40
|
+
npx agentloopkit init --dry-run
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
Run the CLI after install:
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
npx agentloopkit doctor
|
|
47
|
+
npx agentloopkit create-task --title "Add settings page" --type feature
|
|
48
|
+
npx agentloopkit verify
|
|
49
|
+
npx agentloopkit summarize --write
|
|
50
|
+
npx agentloopkit install-agent codex
|
|
51
|
+
npx agentloopkit install-agent all
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
Pinned team usage:
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
pnpm add -D agentloopkit
|
|
58
|
+
pnpm agentloop init
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
Contributor usage:
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
git clone https://github.com/abhiyoheswaran1/agentloopkit
|
|
65
|
+
cd agentloopkit
|
|
66
|
+
pnpm install
|
|
67
|
+
pnpm test
|
|
68
|
+
pnpm build
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
## CLI Commands
|
|
72
|
+
|
|
73
|
+
| Command | Purpose |
|
|
74
|
+
| ------------------------------- | ------------------------------------------------------- |
|
|
75
|
+
| `agentloop init` | Generate the repo harness and config |
|
|
76
|
+
| `agentloop init --dry-run` | Preview generated files without writing them |
|
|
77
|
+
| `agentloop doctor` | Check setup health, commands, git state, and risk files |
|
|
78
|
+
| `agentloop create-task` | Create a task contract in `.agentloop/tasks/` |
|
|
79
|
+
| `agentloop verify` | Run configured checks and write a verification report |
|
|
80
|
+
| `agentloop summarize` | Generate a deterministic PR or reviewer summary |
|
|
81
|
+
| `agentloop install-agent codex` | Add agent-specific instructions |
|
|
82
|
+
| `agentloop install-agent all` | Add all bundled agent instruction files |
|
|
83
|
+
| `agentloop list-templates` | List bundled templates |
|
|
84
|
+
| `agentloop version` | Print the CLI version |
|
|
85
|
+
|
|
86
|
+
The package exposes two binaries:
|
|
87
|
+
|
|
88
|
+
```bash
|
|
89
|
+
agentloop init
|
|
90
|
+
agentloopkit init
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
## Generated Files
|
|
94
|
+
|
|
95
|
+
```text
|
|
96
|
+
.agentloop/
|
|
97
|
+
loops/
|
|
98
|
+
gates/
|
|
99
|
+
handoffs/
|
|
100
|
+
agents/
|
|
101
|
+
policies/
|
|
102
|
+
tasks/
|
|
103
|
+
reports/
|
|
104
|
+
harness/
|
|
105
|
+
AGENTS.md
|
|
106
|
+
AGENTLOOP.md
|
|
107
|
+
agentloop.config.json
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
`init` appends to an existing `AGENTS.md` instead of overwriting it.
|
|
111
|
+
|
|
112
|
+
The package ships `schema/agentloop.config.schema.json` for editors and config validation.
|
|
113
|
+
|
|
114
|
+
See `docs/configuration.md` for config fields and schema notes.
|
|
115
|
+
|
|
116
|
+
## Agent Usage
|
|
117
|
+
|
|
118
|
+
Install instructions for the agent you use:
|
|
119
|
+
|
|
120
|
+
```bash
|
|
121
|
+
agentloop install-agent codex
|
|
122
|
+
agentloop install-agent claude-code
|
|
123
|
+
agentloop install-agent cursor
|
|
124
|
+
agentloop install-agent opencode
|
|
125
|
+
agentloop install-agent gemini-cli
|
|
126
|
+
agentloop install-agent github-copilot-cli
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
AgentLoopKit only writes safe repo-local Markdown instructions when exact third-party config conventions are uncertain.
|
|
130
|
+
|
|
131
|
+
## Task Contracts
|
|
132
|
+
|
|
133
|
+
Create a contract before a coding session:
|
|
134
|
+
|
|
135
|
+
```bash
|
|
136
|
+
agentloop create-task --type feature --title "Add settings page"
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
Each contract records:
|
|
140
|
+
|
|
141
|
+
- problem statement
|
|
142
|
+
- desired outcome
|
|
143
|
+
- constraints
|
|
144
|
+
- non-goals
|
|
145
|
+
- assumptions
|
|
146
|
+
- likely files
|
|
147
|
+
- files not to touch
|
|
148
|
+
- acceptance criteria
|
|
149
|
+
- verification commands
|
|
150
|
+
- rollback notes
|
|
151
|
+
|
|
152
|
+
## Verification Reports
|
|
153
|
+
|
|
154
|
+
`agentloop verify` reads `agentloop.config.json`, runs configured commands, captures output excerpts, and writes a report:
|
|
155
|
+
|
|
156
|
+
```text
|
|
157
|
+
.agentloop/reports/YYYY-MM-DD-HH-mm-verification-report.md
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
It does not hide failures. If no commands are configured, it writes a report saying nothing was verified.
|
|
161
|
+
|
|
162
|
+
## PR Summaries
|
|
163
|
+
|
|
164
|
+
`agentloop summarize` uses deterministic inputs:
|
|
165
|
+
|
|
166
|
+
- git status
|
|
167
|
+
- git diff stats
|
|
168
|
+
- latest task contract
|
|
169
|
+
- latest verification report
|
|
170
|
+
- config settings
|
|
171
|
+
|
|
172
|
+
It does not call an LLM.
|
|
173
|
+
|
|
174
|
+
## Safety Principles
|
|
175
|
+
|
|
176
|
+
AgentLoopKit is intentionally boring:
|
|
177
|
+
|
|
178
|
+
- no postinstall scripts
|
|
179
|
+
- no telemetry
|
|
180
|
+
- no cloud backend
|
|
181
|
+
- no database
|
|
182
|
+
- no API keys
|
|
183
|
+
- no hidden network calls
|
|
184
|
+
- no reading `.env` contents
|
|
185
|
+
- no destructive actions during install
|
|
186
|
+
|
|
187
|
+
Env files are reported by path only.
|
|
188
|
+
|
|
189
|
+
## Compared With Plain AGENTS.md
|
|
190
|
+
|
|
191
|
+
`AGENTS.md` gives instructions. AgentLoopKit adds process artifacts:
|
|
192
|
+
|
|
193
|
+
- task contracts
|
|
194
|
+
- gates
|
|
195
|
+
- policies
|
|
196
|
+
- verification reports
|
|
197
|
+
- PR summaries
|
|
198
|
+
- rollback notes
|
|
199
|
+
|
|
200
|
+
The result is easier to review because the work produces evidence, not only code.
|
|
201
|
+
|
|
202
|
+
## Compared With Prompt Collections
|
|
203
|
+
|
|
204
|
+
Prompt collections help an agent respond better. AgentLoopKit gives the repository a standing workflow that any compatible agent can read and follow.
|
|
205
|
+
|
|
206
|
+
## Compared With Superpowers
|
|
207
|
+
|
|
208
|
+
Superpowers is a broader agent methodology and skills system. AgentLoopKit focuses on repo-level engineering loops, task contracts, verification evidence, and handoff artifacts.
|
|
209
|
+
|
|
210
|
+
They can be complementary. You can use AgentLoopKit alongside Superpowers.
|
|
211
|
+
|
|
212
|
+
AgentLoopKit has no affiliation with Superpowers.
|
|
213
|
+
|
|
214
|
+
## Examples
|
|
215
|
+
|
|
216
|
+
See `examples/` for sample generated harnesses:
|
|
217
|
+
|
|
218
|
+
- `examples/nextjs-app`
|
|
219
|
+
- `examples/node-api`
|
|
220
|
+
- `examples/python-service`
|
|
221
|
+
- `examples/docs-only`
|
|
222
|
+
- `examples/empty-repo`
|
|
223
|
+
|
|
224
|
+
## Roadmap
|
|
225
|
+
|
|
226
|
+
See `ROADMAP.md`.
|
|
227
|
+
|
|
228
|
+
## Publishing Status
|
|
229
|
+
|
|
230
|
+
The repository includes a GitHub Actions publish workflow for npm trusted publishing. Configure the package on npm, publish a GitHub release, and the workflow will run checks before `npm publish --provenance`.
|
|
231
|
+
|
|
232
|
+
See `docs/launch-checklist.md` before publishing.
|
|
233
|
+
|
|
234
|
+
## Contributing
|
|
235
|
+
|
|
236
|
+
See `CONTRIBUTING.md`.
|
|
237
|
+
|
|
238
|
+
## License
|
|
239
|
+
|
|
240
|
+
MIT.
|