faf-cli 7.0.2 → 7.1.2
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 +64 -23
- package/dist/cli.js +248 -248
- package/dist/cli.js.map +14 -12
- package/dist/index.js +2 -2
- package/dist/index.js.map +2 -2
- package/package.json +6 -2
package/README.md
CHANGED
|
@@ -1,31 +1,44 @@
|
|
|
1
1
|
<!-- faf: faf-cli | TypeScript | cli | CLI for the .faf and .fafm IANA-registered formats — AI context + memory that versions with your code -->
|
|
2
2
|
<!-- faf: doc=readme | canonical=project.faf | score=100 | family=FAF -->
|
|
3
3
|
|
|
4
|
-
<div
|
|
5
|
-
<img src="https://www.faf.one/orange-smiley.svg" alt="FAF" width="40" />
|
|
6
|
-
<div>
|
|
7
|
-
<h1 style="margin: 0; color: #000000;">faf-cli — The GIT Version</h1>
|
|
8
|
-
<p style="margin: 2px 0 0 0; font-size: 0.85em; letter-spacing: 0.12em; opacity: 0.7; text-transform: uppercase;"><strong>Context, Versioned.</strong></p>
|
|
9
|
-
<p style="margin: 6px 0 0 0;"><strong>FAF is to Context what Git is to Versions.</strong></p>
|
|
10
|
-
<p style="margin: 0;"><strong>Define once. Run anywhere.</strong></p>
|
|
11
|
-
</div>
|
|
12
|
-
</div>
|
|
4
|
+
<div align="center">
|
|
13
5
|
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
6
|
+
**CONTEXT, versioned.**
|
|
7
|
+
|
|
8
|
+
<img src="https://www.faf.one/orange-smiley.svg" alt="FAF" width="72" />
|
|
9
|
+
|
|
10
|
+
# faf-cli
|
|
18
11
|
|
|
19
|
-
|
|
12
|
+
### The context every AI coding agent reads — authored from your repo, never guessed.
|
|
20
13
|
|
|
21
|
-
**
|
|
14
|
+
**One `.faf` file → `AGENTS.md` · `CLAUDE.md` · `GEMINI.md` · `.cursorrules`,<br>
|
|
15
|
+
detected from your real stack, scored, and versioned with your code. No drift. No re-explaining.**
|
|
22
16
|
|
|
23
|
-
|
|
17
|
+
<!-- ① PRIME — the crown receipts -->
|
|
18
|
+
[](https://github.com/modelcontextprotocol/servers/pull/2759)
|
|
19
|
+
[](https://www.iana.org/assignments/media-types/application/vnd.faf+yaml)
|
|
20
|
+
[](https://www.iana.org/assignments/media-types/application/vnd.fafm+yaml)
|
|
21
|
+
[](https://www.npmjs.com/package/faf-cli)
|
|
22
|
+
[](https://www.npmjs.com/package/faf-cli)
|
|
23
|
+
|
|
24
|
+
**115,000+ downloads across the FAF ecosystem · IANA-registered · Anthropic-merged (#2759)**
|
|
25
|
+
|
|
26
|
+
⭐ **If faf-cli saves you setup time, a star helps other devs find it** —<br>
|
|
27
|
+
despite all our downloads, ~3 of 4 developers check stars before adopting.
|
|
28
|
+
|
|
29
|
+
<!-- ② papers · funnel · testing — one line -->
|
|
30
|
+
[](https://doi.org/10.5281/zenodo.18251362)
|
|
31
|
+
[](https://doi.org/10.5281/zenodo.20348942)
|
|
32
|
+
[](https://github.com/Wolfe-Jam/faf)
|
|
24
33
|
[](https://github.com/Wolfe-Jam/faf-taf-git)
|
|
25
34
|
[](https://github.com/Wolfe-Jam/faf-cli/actions/workflows/ci.yml)
|
|
26
|
-
|
|
27
|
-
[
|
|
28
|
-
|
|
35
|
+
|
|
36
|
+
**[faf.one/cli](https://faf.one/cli)** · FAF defines. MD instructs. AI codes.
|
|
37
|
+
|
|
38
|
+
<!-- trophy — bottom of hero -->
|
|
39
|
+
[](https://faf.one)
|
|
40
|
+
|
|
41
|
+
</div>
|
|
29
42
|
|
|
30
43
|
```
|
|
31
44
|
project/
|
|
@@ -39,7 +52,8 @@ project/
|
|
|
39
52
|
>
|
|
40
53
|
> You have a `package.json`. AI needs you to add a `project.faf`. Done.
|
|
41
54
|
|
|
42
|
-
**Git-Native.** `project.faf` versions with your code — every clone, every fork, every checkout gets full AI context
|
|
55
|
+
**Git-Native.** `project.faf` versions with your code — every clone, every fork, every checkout gets full AI context.<br>
|
|
56
|
+
No setup, no drift, no re-explaining.
|
|
43
57
|
|
|
44
58
|
---
|
|
45
59
|
|
|
@@ -48,7 +62,7 @@ project/
|
|
|
48
62
|
```bash
|
|
49
63
|
bunx faf # Bun — zero install, fastest path
|
|
50
64
|
npx faf # npm — works everywhere
|
|
51
|
-
brew install faf-cli && faf # Homebrew
|
|
65
|
+
brew install wolfe-jam/faf/faf-cli && faf # Homebrew (auto-taps)
|
|
52
66
|
```
|
|
53
67
|
|
|
54
68
|
> `faf` is shorthand for `faf-cli auto` — same behavior, fewer keystrokes.
|
|
@@ -63,6 +77,26 @@ Run `faf` with no arguments:
|
|
|
63
77
|
|
|
64
78
|
---
|
|
65
79
|
|
|
80
|
+
## v7.1 — The AGENTS.md Edition
|
|
81
|
+
|
|
82
|
+
**`faf export --agents` now authors a complete, best-in-class AGENTS.md for any repo — detected from your code, non-destructive, never stale.**
|
|
83
|
+
|
|
84
|
+
Point it at any repo and it detects your build/test commands, key files, conventions (ESLint/Prettier/strict/ruff/mypy…), and guardrails — then writes the definitive AGENTS.md: orientation, setup, tests, where-things-live, conventions, three-tier guardrails, a Definition of Done composed from your real commands, and secrets handling. Facts, not bloat. Your hand-written content is preserved.
|
|
85
|
+
|
|
86
|
+
```bash
|
|
87
|
+
npx faf-cli export --agents
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
---
|
|
91
|
+
|
|
92
|
+
## Context for AI agents
|
|
93
|
+
|
|
94
|
+
FAF-CLI authors the files agents read (AGENTS.md, CLAUDE.md, .cursorrules) from real project detection — zero-install via `bunx faf`.
|
|
95
|
+
|
|
96
|
+
- [→ FAF-CLI for Grok, xAI & Cursor 👀](docs/faf-cli-for-agents.md)
|
|
97
|
+
- [→ FAF-CLI for Claude Code 👀](docs/faf-cli-for-claude.md)
|
|
98
|
+
- [→ FAF-CLI for Bun 👀](docs/faf-cli-for-bun.md)
|
|
99
|
+
|
|
66
100
|
## v7.0 — The GIT Version
|
|
67
101
|
|
|
68
102
|
**FAF is to Context what Git is to Versions.**
|
|
@@ -266,12 +300,12 @@ The WASM scoring kernel (`faf-scoring-kernel` 2.0.0) does the math. Bun does the
|
|
|
266
300
|
| 6 | `faf sync` | `.faf` ↔ CLAUDE.md (bi-sync, mtime auto-direction) |
|
|
267
301
|
| 7 | `faf compile` | `.faf` → `.fafb` binary — sealed, portable, deterministic |
|
|
268
302
|
| 8 | `faf decompile` | `.fafb` → JSON |
|
|
269
|
-
| 9 | `faf export` |
|
|
303
|
+
| 9 | `faf export` | Author AGENTS.md, .cursorrules, GEMINI.md |
|
|
270
304
|
| 10 | `faf check` | Validate `.faf` file |
|
|
271
305
|
| 11 | `faf edit` | Edit `.faf` fields inline |
|
|
272
306
|
| 12 | `faf convert` | Convert `.faf` to JSON |
|
|
273
307
|
| 13 | `faf drift` | Check context drift |
|
|
274
|
-
| 14 | `faf context` |
|
|
308
|
+
| 14 | `faf context` | Author context output |
|
|
275
309
|
| 15 | `faf recover` | Recover `.faf` from CLAUDE.md / AGENTS.md |
|
|
276
310
|
| 16 | `faf migrate` | Migrate `.faf` to latest version |
|
|
277
311
|
| 17 | `faf search` | Search slots and formats |
|
|
@@ -428,3 +462,10 @@ MIT — Free and open source
|
|
|
428
462
|
**IANA-registered:** [`application/vnd.faf+yaml`](https://www.iana.org/assignments/media-types/application/vnd.faf+yaml) (Context Layer) · [`application/vnd.fafm+yaml`](https://www.iana.org/assignments/media-types/application/vnd.fafm+yaml) (Memory Layer)
|
|
429
463
|
|
|
430
464
|
*format | driven 🏎️⚡️ [wolfejam.dev](https://wolfejam.dev)*
|
|
465
|
+
|
|
466
|
+
<div align="center">
|
|
467
|
+
|
|
468
|
+
[](https://opensource.org/licenses/MIT)
|
|
469
|
+
[](https://github.com/Wolfe-Jam/homebrew-faf)
|
|
470
|
+
|
|
471
|
+
</div>
|