@a2f0/agent-tool 0.1.21 → 0.1.22
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 +46 -20
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,34 +1,44 @@
|
|
|
1
1
|
# agent-tool
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
3
|
+
agent-tool is a command-line tool and a set of portable skills for repositories
|
|
4
|
+
where Claude Code, Codex, or OpenCode make the changes. It provides shared Git,
|
|
5
|
+
GitHub, review, validation, and release workflows: independent agent reviews of
|
|
6
|
+
a committed branch, guarded pushes and squash merges of the exact reviewed
|
|
7
|
+
commit, package versioning, brand image rendering, and compact output for noisy
|
|
8
|
+
commands. Repository policy stays in `agent-tool.json`; the portable skills
|
|
9
|
+
coordinate independently reviewed changes.
|
|
6
10
|
|
|
7
|
-
##
|
|
11
|
+
## Quick start
|
|
12
|
+
|
|
13
|
+
Install [Bun](https://bun.sh/) 1.3.11 or newer and Git, then in the project that
|
|
14
|
+
will use agent-tool:
|
|
8
15
|
|
|
9
16
|
```sh
|
|
10
17
|
bun add --dev --exact @a2f0/agent-tool
|
|
11
|
-
|
|
12
|
-
|
|
18
|
+
bun run agent-tool init
|
|
19
|
+
bun run agent-tool skills install --apply
|
|
20
|
+
bun run agent-tool doctor
|
|
13
21
|
```
|
|
14
22
|
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
23
|
+
Restart the agent harness after installing skills if its discovery cache needs
|
|
24
|
+
refreshing.
|
|
25
|
+
|
|
26
|
+
The npm package ships source and embedded skills with no install script. Bun runs
|
|
27
|
+
the executable, so npm projects also need Bun on PATH:
|
|
20
28
|
|
|
21
29
|
```sh
|
|
22
|
-
|
|
23
|
-
bun run agent-tool skills install --apply
|
|
24
|
-
bun run agent-tool doctor
|
|
30
|
+
npm install --save-dev --save-exact @a2f0/agent-tool
|
|
25
31
|
```
|
|
26
32
|
|
|
33
|
+
Version preparation needs Bun 1.4 or newer. GitHub operations require an
|
|
34
|
+
authenticated `gh` supporting `pr checks --json`, and independent reviews require
|
|
35
|
+
an authenticated Claude Code, Codex, or OpenCode CLI. A compiled standalone
|
|
36
|
+
executable needs no Bun or Node at runtime.
|
|
37
|
+
|
|
27
38
|
Add `"agent-tool": "agent-tool"` to package scripts, or invoke
|
|
28
39
|
`node_modules/.bin/agent-tool` directly. Use the direct executable for an empty
|
|
29
40
|
positional argument. Global `--repo <directory>` and `--config <file>` select a
|
|
30
|
-
checkout and explicit policy file.
|
|
31
|
-
skills if its discovery cache needs refreshing.
|
|
41
|
+
checkout and explicit policy file.
|
|
32
42
|
|
|
33
43
|
## Normal usage
|
|
34
44
|
|
|
@@ -44,10 +54,26 @@ agent-tool pr preflight <reviewed-head> <base-branch> <reviewed-base>
|
|
|
44
54
|
agent-tool pr merge 'chore: maintain repository' <reviewed-head> <base-branch>
|
|
45
55
|
```
|
|
46
56
|
|
|
47
|
-
|
|
48
|
-
feedback, merge, cleanup, and deployment workflow
|
|
49
|
-
|
|
50
|
-
|
|
57
|
+
The bundled `ship-pr` skill runs the full validation, versioning, independent
|
|
58
|
+
review, feedback, merge, cleanup, and deployment workflow from your agent
|
|
59
|
+
harness. The [CLI reference](docs/reference.md#commands) explains what a review
|
|
60
|
+
result means, and [shared workflows](docs/workflows.md) describes each
|
|
61
|
+
repository command's contract.
|
|
62
|
+
|
|
63
|
+
## Development
|
|
64
|
+
|
|
65
|
+
To work on agent-tool itself, install [mise](https://mise.jdx.dev/), then run
|
|
66
|
+
from a clone:
|
|
67
|
+
|
|
68
|
+
```sh
|
|
69
|
+
mise install
|
|
70
|
+
bun install --frozen-lockfile
|
|
71
|
+
bun src/index.ts --help
|
|
72
|
+
bun test
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
[Development](docs/development.md) covers the source layout, the full
|
|
76
|
+
validation suite, and release procedures.
|
|
51
77
|
|
|
52
78
|
## Documentation
|
|
53
79
|
|