@agentfile/cli 0.1.2 → 0.1.4
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 +69 -0
- package/package.json +3 -2
package/README.md
ADDED
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
# @agentfile/cli
|
|
2
|
+
|
|
3
|
+
> One contract. Every AI agent. Zero clutter.
|
|
4
|
+
|
|
5
|
+
CLI for [agentfile](https://github.com/dennishavermans/agentfile) — scaffold, generate and validate AI agent instruction files from a single `contract.yaml`.
|
|
6
|
+
|
|
7
|
+
## Usage
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npx @agentfile/cli init
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Walks you through setup and scaffolds everything — `ai/contract.yaml`, agent templates, `.ai-agents.example`, and a CI workflow.
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
npx @agentfile/cli sync
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
Reads your personal `.ai-agents` file and generates the correct instruction file for each agent in its native format.
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
npx @agentfile/cli validate
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
Validates `ai/contract.yaml` against the schema. Exits 0 or 1. Designed for CI.
|
|
26
|
+
|
|
27
|
+
## What it generates
|
|
28
|
+
|
|
29
|
+
| Agent | File |
|
|
30
|
+
|---|---|
|
|
31
|
+
| `claude` | `CLAUDE.md` |
|
|
32
|
+
| `copilot` | `.github/copilot-instructions.md` |
|
|
33
|
+
| `cursor` | `.cursor/rules/main.mdc` + one `.mdc` per skill |
|
|
34
|
+
| `agents-md` | `AGENTS.md` — read natively by Codex and Windsurf |
|
|
35
|
+
|
|
36
|
+
Generated files are gitignored. Each developer picks which agents they use without touching the repo.
|
|
37
|
+
|
|
38
|
+
## Your contract
|
|
39
|
+
|
|
40
|
+
```yaml
|
|
41
|
+
version: 1
|
|
42
|
+
|
|
43
|
+
project:
|
|
44
|
+
name: My Project
|
|
45
|
+
stack: [typescript, react]
|
|
46
|
+
|
|
47
|
+
rules:
|
|
48
|
+
coding:
|
|
49
|
+
- Prefer small composable functions
|
|
50
|
+
architecture:
|
|
51
|
+
- Follow feature-based folder structure
|
|
52
|
+
|
|
53
|
+
skills:
|
|
54
|
+
- name: create-component
|
|
55
|
+
description: Creates a new React component with tests
|
|
56
|
+
steps:
|
|
57
|
+
- Create /src/components/{feature}/{Name}.tsx
|
|
58
|
+
- Create matching test file
|
|
59
|
+
- Export from index.ts
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
## Links
|
|
63
|
+
|
|
64
|
+
- [Full documentation](https://github.com/dennishavermans/agentfile)
|
|
65
|
+
- [Core engine](https://www.npmjs.com/package/@agentfile/core)
|
|
66
|
+
|
|
67
|
+
## License
|
|
68
|
+
|
|
69
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,13 +1,14 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@agentfile/cli",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.4",
|
|
4
4
|
"description": "CLI for agentfile — init, sync, and validate AI agent contracts",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"bin": {
|
|
7
7
|
"agentfile": "./dist/bin.js"
|
|
8
8
|
},
|
|
9
9
|
"files": [
|
|
10
|
-
"dist"
|
|
10
|
+
"dist",
|
|
11
|
+
"README.md"
|
|
11
12
|
],
|
|
12
13
|
"scripts": {
|
|
13
14
|
"build": "tsc",
|