agentloopkit 0.1.0 → 0.24.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.
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "$schema": "https://json-schema.org/draft/2020-12/schema",
3
- "$id": "https://agentloopkit.dev/schema/agentloop.config.schema.json",
3
+ "$id": "https://raw.githubusercontent.com/abhiyoheswaran1/AgentLoopKit/main/schema/agentloop.config.schema.json",
4
4
  "title": "AgentLoopKit Configuration",
5
5
  "type": "object",
6
6
  "additionalProperties": false,
@@ -7,6 +7,12 @@ Before editing:
7
7
  - Read AGENTS.md and AGENTLOOP.md.
8
8
  - Read harness files under .agentloop/harness/.
9
9
  - Check .agentloop/tasks/ for current work.
10
+ - Run `agentloop task list` when current work is unclear.
11
+ - Run `agentloop task show <path>` before implementing a selected task.
12
+ - Run `agentloop task status <path> in-progress` when implementation starts.
13
+ - Run `agentloop task archive <path>` only after verification and handoff are complete.
14
+ - Run `agentloop policy list`, `agentloop policy show <policy>`, and `agentloop policy status` before risky edits.
15
+ - Run `agentloop check-gates` before stopping to check review evidence.
10
16
 
11
17
  Rules:
12
18
 
@@ -7,6 +7,12 @@ Before editing:
7
7
  - Read AGENTS.md.
8
8
  - Read AGENTLOOP.md.
9
9
  - Check .agentloop/tasks/ for the active task contract.
10
+ - Run `agentloop task list` when the active task is unclear.
11
+ - Run `agentloop task show <path>` before implementing a selected task.
12
+ - Run `agentloop task status <path> in-progress` when implementation starts.
13
+ - Run `agentloop task archive <path>` only after verification and handoff are complete.
14
+ - Run `agentloop policy list`, `agentloop policy show <policy>`, and `agentloop policy status` before risky edits.
15
+ - Run `agentloop check-gates` before stopping to check review evidence.
10
16
  - Review .agentloop/harness/commands.md.
11
17
 
12
18
  Work loop:
@@ -6,6 +6,12 @@ Before editing:
6
6
 
7
7
  - Read AGENTS.md and AGENTLOOP.md.
8
8
  - Use the active task contract when present.
9
+ - Run `agentloop task list` when several task contracts exist.
10
+ - Run `agentloop task show <path>` before implementing a selected task.
11
+ - Run `agentloop task status <path> in-progress` when implementation starts.
12
+ - Run `agentloop task archive <path>` only after verification and handoff are complete.
13
+ - Run `agentloop policy list`, `agentloop policy show <policy>`, and `agentloop policy status` before risky edits.
14
+ - Run `agentloop check-gates` before stopping to check review evidence.
9
15
  - Keep diffs focused on acceptance criteria.
10
16
 
11
17
  Verification:
@@ -8,6 +8,12 @@ Before editing:
8
8
  - Read AGENTLOOP.md.
9
9
  - Read .agentloop/harness/commands.md.
10
10
  - Check .agentloop/tasks/ for active work.
11
+ - Run `agentloop task list` when active work is unclear.
12
+ - Run `agentloop task show <path>` before implementing a selected task.
13
+ - Run `agentloop task status <path> in-progress` when implementation starts.
14
+ - Run `agentloop task archive <path>` only after verification and handoff are complete.
15
+ - Run `agentloop policy list`, `agentloop policy show <policy>`, and `agentloop policy status` before risky edits.
16
+ - Run `agentloop check-gates` before stopping to check review evidence.
11
17
 
12
18
  Rules:
13
19
 
@@ -7,6 +7,12 @@ Before editing:
7
7
  - Read AGENTS.md.
8
8
  - Read AGENTLOOP.md.
9
9
  - Check .agentloop/tasks/.
10
+ - Run `agentloop task list` when several task contracts exist.
11
+ - Run `agentloop task show <path>` before implementing a selected task.
12
+ - Run `agentloop task status <path> in-progress` when implementation starts.
13
+ - Run `agentloop task archive <path>` only after verification and handoff are complete.
14
+ - Run `agentloop policy list`, `agentloop policy show <policy>`, and `agentloop policy status` before risky edits.
15
+ - Run `agentloop check-gates` before stopping to check review evidence.
10
16
 
11
17
  Loop:
12
18
 
@@ -7,6 +7,12 @@ Before editing:
7
7
  - Read AGENTS.md.
8
8
  - Read AGENTLOOP.md.
9
9
  - Check task contracts in .agentloop/tasks/.
10
+ - Run `agentloop task list` when current work is unclear.
11
+ - Run `agentloop task show <path>` before implementing a selected task.
12
+ - Run `agentloop task status <path> in-progress` when implementation starts.
13
+ - Run `agentloop task archive <path>` only after verification and handoff are complete.
14
+ - Run `agentloop policy list`, `agentloop policy show <policy>`, and `agentloop policy status` before risky edits.
15
+ - Run `agentloop check-gates` before stopping to check review evidence.
10
16
 
11
17
  Rules:
12
18
 
@@ -7,6 +7,12 @@ Before editing:
7
7
  - Read AGENTS.md.
8
8
  - Read AGENTLOOP.md.
9
9
  - Check .agentloop/tasks/.
10
+ - Run `agentloop task list` when current work is unclear.
11
+ - Run `agentloop task show <path>` before implementing a selected task.
12
+ - Run `agentloop task status <path> in-progress` when implementation starts.
13
+ - Run `agentloop task archive <path>` only after verification and handoff are complete.
14
+ - Run `agentloop policy list`, `agentloop policy show <policy>`, and `agentloop policy status` before risky edits.
15
+ - Run `agentloop check-gates` before stopping to check review evidence.
10
16
 
11
17
  Rules:
12
18
 
@@ -10,7 +10,48 @@ Detected during AgentLoopKit init:
10
10
 
11
11
  Rules:
12
12
 
13
+ - Use `agentloop task list` to inspect task contracts before pinning one.
14
+ - Use `agentloop task show <path>` to read a task contract without changing active state.
15
+ - Use `agentloop task set <path>` when the active task is ambiguous.
16
+ - Use `agentloop task status <path> <status>` to update task state without hand-editing Markdown.
17
+ - Use `agentloop task archive <path>` only after verification and handoff are complete.
18
+ - Use `agentloop status` to inspect active task, latest report, dirty files, and next action.
19
+ - Use `agentloop next` when you only need the next recommended loop command.
20
+ - Use `agentloop policy list`, `agentloop policy show <policy>`, and `agentloop policy status` to inspect local safety guidance and template drift before risky edits.
21
+ - Follow local `.agentloop/policies/*.md` files as repo policy. Treat `modified` as a reviewed local rule, not an error.
22
+ - Use `agentloop check-gates` to check task, verification, handoff, harness, policy, and git evidence before review.
23
+ - Use `agentloop check-gates --strict` in CI when warning gates should fail.
24
+ - Use `agentloop report` after verification and handoff when reviewers need one local HTML evidence artifact.
25
+ - Use `agentloop badge` when reviewers or CI need a local SVG evidence badge.
26
+ - Use `agentloop ci-summary --write` in CI when reviewers need a compact provenance and evidence summary.
27
+ - Use `agentloop release-notes --write` before a release when reviewers need local release-note evidence.
28
+ - Use `agentloop npm-status` after release attempts to check whether npm latest matches local package metadata.
29
+ - Use `agentloop npm-status --expect-current` as a post-publish smoke check. It never publishes or reads credentials.
13
30
  - Run targeted checks while developing.
14
31
  - Run configured verification before claiming completion.
15
32
  - If a command fails, report the failure and fix it when reasonable.
16
33
  - If a command is not configured, say so in the handoff.
34
+
35
+ ## CI Usage
36
+
37
+ Use `agentloop check-gates --strict` in CI after task, verification, and handoff evidence exists. If CI generates reports and handoffs, upload `.agentloop/reports/*.md`, `.agentloop/reports/*.html`, `.agentloop/reports/*.svg`, and `.agentloop/handoffs/*.md` as build artifacts instead of committing them automatically.
38
+
39
+ When `agentloop verify` runs in GitHub Actions, the verification report records allowlisted CI provenance fields such as workflow, event, ref, commit, run URL, and run attempt. It does not dump arbitrary environment variables.
40
+
41
+ Use `agentloop ci-summary --write` after verification and handoff when CI should upload one compact Markdown summary of CI provenance, AgentLoop evidence, and gate status. It does not run checks or replace the verification report.
42
+
43
+ Use `agentloop release-notes --write` after verification when a release workflow needs a local release-note draft from changelog, git, task, verification, and CI-summary evidence. It does not create tags, publish packages, call provider APIs, or read tokens.
44
+
45
+ Use `agentloop npm-status` when release docs mention npm availability. It runs `npm view` only when invoked, or reads captured registry JSON with `--registry-json`. It does not publish packages, read tokens, read `.env` files, or change package metadata.
46
+
47
+ `check-gates` checks evidence. It does not prove the code is correct and does not replace review.
48
+
49
+ ## Monorepos
50
+
51
+ If `agentloop doctor` reports workspace or monorepo markers, treat root commands as coverage clues, not proof that every package was checked.
52
+
53
+ - Add package-specific verification commands to the task contract when a change is scoped to one package.
54
+ - Prefer the repo's existing command style, such as `pnpm --filter <package> test`, `npm --workspace <package> test`, or a package-local command.
55
+ - Run root checks when they cover the touched area.
56
+ - In the handoff, separate root checks, package-level checks, and checks that were not run.
57
+ - Do not claim full monorepo verification from a root-only command unless the repo documentation says that command covers all affected packages.
@@ -6,4 +6,5 @@
6
6
  - [ ] Tests or documented verification cover the change.
7
7
  - [ ] Docs were updated when behavior changed.
8
8
  - [ ] Protected areas were reviewed.
9
+ - [ ] Policy changes were reviewed when `.agentloop/policies/` changed.
9
10
  - [ ] Rollback notes are clear.
@@ -21,6 +21,7 @@ AgentLoopKit gives coding agents a repeatable engineering loop inside this repo.
21
21
  - .agentloop/reports/: verification reports generated by `agentloop verify`.
22
22
  - .agentloop/handoffs/: PR summaries and reviewer handoffs.
23
23
  - .agentloop/harness/: repo-specific working agreement, commands, and checklists.
24
+ - .agentloop/state.json: active task pointer created by `agentloop task set`.
24
25
 
25
26
  ## Commands Detected During Init
26
27
 
@@ -32,6 +33,10 @@ AgentLoopKit gives coding agents a repeatable engineering loop inside this repo.
32
33
  - Build: {{ buildCommand }}
33
34
  - Format: {{ formatCommand }}
34
35
 
36
+ Use `agentloop task list` to inspect available task contracts. Use `agentloop task show <path>` to read one without changing active state. Use `agentloop task set <path>` to pin the active task when a repo has multiple contracts. Use `agentloop task status <path> <status>` to update the task contract state. Use `agentloop task archive <path>` after verification and handoff to move a finished contract into `.agentloop/tasks/archive/` without deleting it. Use `agentloop status` to inspect the active task, latest verification report, working tree state, and next suggested command. Use `agentloop next` when an agent or script only needs the next recommended loop command. Use `agentloop policy list`, `agentloop policy show <policy>`, and `agentloop policy status` to inspect local safety guidance and template drift before risky edits. Use `agentloop check-gates` before review to check task, verification, handoff, harness, policy, and git evidence. Use `agentloop check-gates --strict` in CI when warning gates should fail. Use `agentloop report` after verification and handoff when reviewers need one local HTML evidence artifact. Use `agentloop badge` when reviewers or CI need a local SVG status badge. Use `agentloop ci-summary --write` in CI when reviewers need a compact provenance and evidence summary. Use `agentloop release-notes --write` before a release when reviewers need local release-note evidence. Use `agentloop npm-status` before claiming npm availability in release notes or docs.
37
+
38
+ Local files under `.agentloop/policies/` are the repo's policy source of truth. Bundled templates are comparison material. Treat `modified` policy status as a prompt to read the local rule, not as a reason to overwrite it.
39
+
35
40
  ## Autonomous Work
36
41
 
37
42
  Agents may work autonomously inside the task contract. They should stop and ask before changing protected areas, adding dependencies, introducing breaking public APIs, or taking destructive actions.
@@ -8,6 +8,21 @@ Before changing code:
8
8
 
9
9
  - Read AGENTLOOP.md.
10
10
  - Check .agentloop/tasks/ for an active task contract.
11
+ - Use `agentloop task list` to inspect available task contracts before choosing one.
12
+ - Use `agentloop task show <path>` to read a task contract without changing active state.
13
+ - Use `agentloop task set <path>` when the active task is ambiguous.
14
+ - Use `agentloop task status <path> <status>` to update task state without hand-editing Markdown.
15
+ - Use `agentloop task archive <path>` only after verification and handoff are complete.
16
+ - Run `agentloop status` when you need the current task, verification, dirty-file, and next-action state.
17
+ - Run `agentloop next` when you only need the next recommended loop command.
18
+ - Run `agentloop policy list`, `agentloop policy show <policy>`, and `agentloop policy status` before touching security, dependency, database, git, public API, or secret-handling areas.
19
+ - Treat local `.agentloop/policies/*.md` files as the repo's safety guidance. A `modified` policy is a local decision to review, not a failure.
20
+ - Run `agentloop check-gates` before stopping to check review evidence.
21
+ - Run `agentloop report` after verification and handoff when a local HTML evidence artifact helps review.
22
+ - Run `agentloop badge` when a local SVG evidence badge helps review or CI artifact uploads.
23
+ - Run `agentloop ci-summary --write` in CI when reviewers need a compact provenance and evidence summary.
24
+ - Run `agentloop release-notes --write` before a release when reviewers need local release-note evidence.
25
+ - Run `agentloop npm-status` before claiming npm availability in release notes or docs.
11
26
  - Follow the Specify, Constrain, Plan, Implement, Verify, Review, Handoff loop.
12
27
  - Keep changes small and tied to the task contract.
13
28
  - Do not run destructive git or filesystem commands unless the user asks for them.
@@ -2,6 +2,8 @@
2
2
 
3
3
  This directory contains repo-local engineering loop artifacts for coding agents and reviewers.
4
4
 
5
+ `manifest.json` records the AgentLoopKit template generation used to create this harness. `agentloop doctor` reads it and warns when the local harness is missing template metadata, older than the current CLI, invalid, or newer than the CLI supports.
6
+
5
7
  ## Start Here
6
8
 
7
9
  1. Read `../AGENTS.md`.
@@ -10,23 +12,107 @@ This directory contains repo-local engineering loop artifacts for coding agents
10
12
 
11
13
  ```bash
12
14
  agentloop create-task --title "Describe the next focused change" --type feature
15
+ agentloop task list
16
+ agentloop task show .agentloop/tasks/<task-file>.md
17
+ agentloop task set .agentloop/tasks/<task-file>.md
18
+ agentloop task status .agentloop/tasks/<task-file>.md in-progress
19
+ agentloop task archive .agentloop/tasks/<task-file>.md
20
+ ```
21
+
22
+ Archive only after verification and handoff. The archive command moves one named Markdown file into `.agentloop/tasks/archive/` and keeps normal task lists focused.
23
+
24
+ 4. Check current loop state:
25
+
26
+ ```bash
27
+ agentloop status
28
+ agentloop next
13
29
  ```
14
30
 
15
- 4. Run verification when work is ready:
31
+ 5. Inspect safety policies when the task touches protected areas:
32
+
33
+ ```bash
34
+ agentloop policy list
35
+ agentloop policy show security
36
+ agentloop policy status
37
+ ```
38
+
39
+ Local policy files are repo guidance. If `policy status` reports `modified`, read the local file and follow the repo-specific rule. Do not overwrite customized policy text just to match the bundled template.
40
+
41
+ 6. Run verification when work is ready:
16
42
 
17
43
  ```bash
18
44
  agentloop verify
19
45
  ```
20
46
 
21
- 5. Generate a reviewer handoff:
47
+ 7. Generate a reviewer handoff:
48
+
49
+ ```bash
50
+ agentloop handoff
51
+ ```
52
+
53
+ 8. Optional: write a local HTML evidence report:
54
+
55
+ ```bash
56
+ agentloop report
57
+ ```
58
+
59
+ 9. Optional: write a local SVG evidence badge:
60
+
61
+ ```bash
62
+ agentloop badge
63
+ agentloop badge --source gates
64
+ ```
65
+
66
+ 10. Optional: write a CI summary:
67
+
68
+ ```bash
69
+ agentloop ci-summary
70
+ agentloop ci-summary --write
71
+ ```
72
+
73
+ 11. Optional: draft release notes:
74
+
75
+ ```bash
76
+ agentloop release-notes
77
+ agentloop release-notes --write
78
+ ```
79
+
80
+ 12. Optional: check npm registry catch-up:
81
+
82
+ ```bash
83
+ agentloop npm-status
84
+ agentloop npm-status --expect-current
85
+ ```
86
+
87
+ 13. Check review gates:
22
88
 
23
89
  ```bash
24
- agentloop summarize --write
90
+ agentloop check-gates
91
+ agentloop check-gates --strict
25
92
  ```
26
93
 
94
+ `check-gates` inspects local evidence. It does not run tests or call an LLM.
95
+ `report` reads local evidence and writes one static HTML file under `reports/`.
96
+ `badge` reads local evidence and writes SVG files under `reports/`.
97
+ `ci-summary` reads allowlisted CI provenance and local evidence, then writes Markdown under `reports/` when `--write` is passed.
98
+ `release-notes` reads local package, changelog, git, task, verification, and CI-summary evidence, then writes Markdown under `handoffs/` when `--write` is passed.
99
+ `npm-status` compares local package metadata with npm registry metadata. It does not publish packages or read credentials.
100
+ Use `--strict` in CI when warning gates should fail.
101
+
102
+ CI can either check committed AgentLoop evidence or generate reports and handoffs as build artifacts. Do not let CI commit generated files unless maintainers explicitly want that behavior.
103
+
104
+ When GitHub Actions runs `agentloop verify`, the report records allowlisted CI provenance fields such as workflow, event, ref, commit, run URL, and run attempt. AgentLoopKit does not print arbitrary environment variables.
105
+
106
+ Use `agentloop ci-summary --write` after verification and handoff when CI should upload one compact Markdown summary. It does not run checks or replace the verification report.
107
+
108
+ Use `agentloop release-notes --write` before a release when CI or maintainers need a local release-note draft. It does not create tags, publish packages, call provider APIs, or read tokens.
109
+
110
+ Use `agentloop npm-status --expect-current` after npm publish when CI or maintainers need proof that npm latest matches local package metadata. It does not publish packages, read tokens, read `.env` files, or change package metadata.
111
+
27
112
  ## Directories
28
113
 
29
114
  - `loops/`: task-specific workflows
115
+ - `manifest.json`: generated template version metadata
30
116
  - `gates/`: pass/fail checklists
31
117
  - `policies/`: safety rules
32
118
  - `tasks/`: task contracts
@@ -34,3 +120,17 @@ agentloop summarize --write
34
120
  - `handoffs/`: PR summaries and reviewer briefs
35
121
  - `agents/`: agent-specific instructions
36
122
  - `harness/`: repo working agreement and commands
123
+
124
+ ## Monorepo Notes
125
+
126
+ When this repository has workspace markers, use both root and package-level checks as needed. Put package-specific verification commands in the task contract so agents and reviewers can see what the change requires.
127
+
128
+ Examples:
129
+
130
+ ```bash
131
+ pnpm --filter <package> test
132
+ npm --workspace <package> test
133
+ cd packages/<name> && npm test
134
+ ```
135
+
136
+ Root checks are useful when they cover the touched package. If they do not, say what was not verified in the handoff.
@@ -1,5 +1,5 @@
1
1
  {
2
- "$schema": "https://agentloopkit.dev/schema/agentloop.config.schema.json",
2
+ "$schema": "https://raw.githubusercontent.com/abhiyoheswaran1/AgentLoopKit/main/schema/agentloop.config.schema.json",
3
3
  "version": 1,
4
4
  "project": {
5
5
  "name": "{{ projectName }}",
@@ -4,6 +4,32 @@ Create task contracts with:
4
4
 
5
5
  ```bash
6
6
  agentloop create-task
7
+ agentloop create-task --type feature --title "Add settings page" \
8
+ --problem-statement "Users cannot manage account preferences" \
9
+ --desired-outcome "Users can update settings from the app" \
10
+ --likely-file src/settings \
11
+ --forbidden-file migrations/ \
12
+ --acceptance "Settings can be saved" \
13
+ --verification "pnpm test" \
14
+ --rollback "Remove the settings route"
7
15
  ```
8
16
 
9
17
  Task contracts turn fuzzy requests into scoped engineering work. A good contract names the desired outcome, constraints, non-goals, likely files, files not to touch, acceptance criteria, verification commands, and rollback notes.
18
+
19
+ In monorepos, include package-specific verification commands when root commands do not prove the touched package. Examples include `pnpm --filter <package> test`, `npm --workspace <package> test`, or a package-local command from inside `packages/<name>`.
20
+
21
+ When several task contracts exist, pin the one in progress:
22
+
23
+ ```bash
24
+ agentloop task list
25
+ agentloop task show .agentloop/tasks/<task-file>.md
26
+ agentloop task set .agentloop/tasks/<task-file>.md
27
+ agentloop task status .agentloop/tasks/<task-file>.md in-progress
28
+ agentloop task archive .agentloop/tasks/<task-file>.md
29
+ ```
30
+
31
+ `agentloop task list --json` is safe for agents and scripts. It reads task files and does not create or update `.agentloop/state.json`.
32
+ `agentloop create-task --json` returns the created task path and Markdown content for scripts and agents.
33
+ `agentloop task show --json` returns one task contract's metadata and Markdown content without changing active state.
34
+ `agentloop task status --json` updates only the task contract's `- Status:` line. Supported statuses are `proposed`, `in-progress`, `blocked`, `review`, and `done`.
35
+ `agentloop task archive --json` moves one named task contract into `.agentloop/tasks/archive/` after verification and handoff. It preserves the Markdown file and refuses to overwrite an existing archive file.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "agentloopkit",
3
- "version": "0.1.0",
3
+ "version": "0.24.0",
4
4
  "description": "A drop-in engineering loop for coding agents.",
5
5
  "type": "module",
6
6
  "bin": {
@@ -45,10 +45,11 @@
45
45
  "dev": "tsx src/cli/index.ts",
46
46
  "test": "vitest run",
47
47
  "test:watch": "vitest",
48
+ "check:links": "tsx scripts/check-markdown-links.ts",
48
49
  "typecheck": "tsc --noEmit",
49
50
  "lint": "eslint .",
50
51
  "format": "prettier --write .",
51
- "prepublishOnly": "npm run typecheck && npm test && npm run build"
52
+ "prepublishOnly": "node scripts/prepublish-check.mjs && npm run typecheck && npm test && npm run build"
52
53
  },
53
54
  "dependencies": {
54
55
  "commander": "^14.0.2",
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "$schema": "https://json-schema.org/draft/2020-12/schema",
3
- "$id": "https://agentloopkit.dev/schema/agentloop.config.schema.json",
3
+ "$id": "https://raw.githubusercontent.com/abhiyoheswaran1/AgentLoopKit/main/schema/agentloop.config.schema.json",
4
4
  "title": "AgentLoopKit Configuration",
5
5
  "type": "object",
6
6
  "additionalProperties": false,