faf 1.0.3 → 6.5.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/README.md +12 -44
- package/bin/faf.js +9 -5
- package/package.json +8 -15
package/README.md
CHANGED
|
@@ -1,51 +1,19 @@
|
|
|
1
|
-
#
|
|
1
|
+
# faf
|
|
2
2
|
|
|
3
|
-
**
|
|
4
|
-
|
|
5
|
-
Project DNA for AI. Like package.json, but for context.
|
|
6
|
-
|
|
7
|
-
## Install
|
|
8
|
-
|
|
9
|
-
```bash
|
|
10
|
-
npm install -g faf
|
|
11
|
-
```
|
|
12
|
-
|
|
13
|
-
## Usage
|
|
3
|
+
**Thin alias for `faf-cli`.** Same CLI, shorter name.
|
|
14
4
|
|
|
15
5
|
```bash
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
faf
|
|
19
|
-
faf
|
|
20
|
-
faf bi-sync # Keep .faf and CLAUDE.md in sync
|
|
6
|
+
bunx faf init
|
|
7
|
+
bunx faf auto
|
|
8
|
+
bunx faf go
|
|
9
|
+
bunx faf wjttc
|
|
21
10
|
```
|
|
22
11
|
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
FAF encapsulates project goals, stack, rules, and architecture in a structured YAML format. Run faf-CLI commands and get AI-Context in seconds — no uploads required.
|
|
26
|
-
|
|
27
|
-
## Ecosystem
|
|
28
|
-
|
|
29
|
-
- **faf-cli** - CLI toolchain (this package wraps it)
|
|
30
|
-
- **claude-faf-mcp** - Official Anthropic MCP integration
|
|
31
|
-
- **faf-mcp** - MCP server implementation
|
|
32
|
-
- **grok-faf-mcp** - xAI Grok MCP server
|
|
33
|
-
- **gemini-faf-mcp** - Google Gemini MCP server
|
|
34
|
-
|
|
35
|
-
## Links
|
|
36
|
-
|
|
37
|
-
- Website: [faf.one](https://faf.one)
|
|
38
|
-
- GitHub: [github.com/Wolfe-Jam/faf](https://github.com/Wolfe-Jam/faf)
|
|
39
|
-
- IANA Registration: [application/vnd.faf+yaml](https://www.iana.org/assignments/media-types/application/vnd.faf+yaml)
|
|
40
|
-
|
|
41
|
-
## Downloads
|
|
42
|
-
|
|
43
|
-
50,000+ downloads across the FAF ecosystem.
|
|
44
|
-
|
|
45
|
-
## License
|
|
46
|
-
|
|
47
|
-
MIT
|
|
12
|
+
This package resolves [`faf-cli`](https://npmjs.com/package/faf-cli) at install time and forwards args through. All docs, all commands, all features live in the canonical CLI.
|
|
48
13
|
|
|
49
|
-
|
|
14
|
+
- **Canonical CLI:** https://npmjs.com/package/faf-cli
|
|
15
|
+
- **Spec:** https://faf.one
|
|
16
|
+
- **Issues:** https://github.com/Wolfe-Jam/faf-cli/issues
|
|
17
|
+
- **Format:** IANA-registered `application/vnd.faf+yaml`
|
|
50
18
|
|
|
51
|
-
|
|
19
|
+
> FAF defines. MD instructs. AI codes.
|
package/bin/faf.js
CHANGED
|
@@ -1,14 +1,18 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
|
-
* FAF
|
|
4
|
+
* FAF — Foundational AI-context Format
|
|
5
5
|
* IANA-registered: application/vnd.faf+yaml
|
|
6
6
|
*
|
|
7
|
-
*
|
|
8
|
-
*
|
|
9
|
-
* Usage: faf | faf init | faf auto | faf go
|
|
7
|
+
* Thin alias for `faf-cli`. Resolves the canonical CLI at install time
|
|
8
|
+
* (via `faf-cli: latest` dependency) and forwards user args through.
|
|
10
9
|
*
|
|
11
|
-
*
|
|
10
|
+
* Install: bunx faf | npx faf | npm install -g faf
|
|
11
|
+
* Usage: faf | faf init | faf auto | faf go | faf wjttc | ...
|
|
12
|
+
*
|
|
13
|
+
* Canonical CLI: https://npmjs.com/package/faf-cli
|
|
14
|
+
* Spec: https://faf.one
|
|
15
|
+
* Bugs: https://github.com/Wolfe-Jam/faf-cli/issues
|
|
12
16
|
*/
|
|
13
17
|
|
|
14
18
|
const { execFileSync } = require('child_process');
|
package/package.json
CHANGED
|
@@ -1,19 +1,9 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "faf",
|
|
3
|
-
"version": "
|
|
4
|
-
"description": "FAF
|
|
5
|
-
"keywords": [
|
|
6
|
-
|
|
7
|
-
"ai-context",
|
|
8
|
-
"ai",
|
|
9
|
-
"context",
|
|
10
|
-
"llm",
|
|
11
|
-
"claude",
|
|
12
|
-
"grok",
|
|
13
|
-
"mcp",
|
|
14
|
-
"yaml"
|
|
15
|
-
],
|
|
16
|
-
"author": "Wolfe James <wolfe@wolfejam.dev> (https://wolfejam.dev)",
|
|
3
|
+
"version": "6.5.0",
|
|
4
|
+
"description": "FAF — Foundational AI-context Format. IANA-registered (application/vnd.faf+yaml). Project DNA for AI. This package is a thin alias to faf-cli — see the canonical CLI for full docs.",
|
|
5
|
+
"keywords": ["faf", "ai-context", "ai", "context", "llm", "claude", "grok", "mcp", "yaml", "cli"],
|
|
6
|
+
"author": "wolfejam <wolfejam@faf.one>",
|
|
17
7
|
"license": "MIT",
|
|
18
8
|
"repository": {
|
|
19
9
|
"type": "git",
|
|
@@ -21,12 +11,15 @@
|
|
|
21
11
|
},
|
|
22
12
|
"homepage": "https://faf.one",
|
|
23
13
|
"bugs": {
|
|
24
|
-
"url": "https://github.com/Wolfe-Jam/faf/issues"
|
|
14
|
+
"url": "https://github.com/Wolfe-Jam/faf-cli/issues"
|
|
25
15
|
},
|
|
26
16
|
"dependencies": {
|
|
27
17
|
"faf-cli": "latest"
|
|
28
18
|
},
|
|
29
19
|
"bin": {
|
|
30
20
|
"faf": "./bin/faf.js"
|
|
21
|
+
},
|
|
22
|
+
"engines": {
|
|
23
|
+
"node": ">=18.0.0"
|
|
31
24
|
}
|
|
32
25
|
}
|