faf 1.0.1
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 +47 -0
- package/bin/faf.js +14 -0
- package/package.json +32 -0
package/README.md
ADDED
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# FAF - Foundational AI-context Format
|
|
2
|
+
|
|
3
|
+
**IANA-registered standard: `application/vnd.faf+yaml`**
|
|
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
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
faf init # Initialize .faf from your project
|
|
17
|
+
faf auto # Zero-to-context instantly
|
|
18
|
+
faf bi-sync # Keep .faf and CLAUDE.md in sync
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## What is FAF?
|
|
22
|
+
|
|
23
|
+
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.
|
|
24
|
+
|
|
25
|
+
## Ecosystem
|
|
26
|
+
|
|
27
|
+
- **faf-cli** - CLI toolchain (this package wraps it)
|
|
28
|
+
- **claude-faf-mcp** - Official Anthropic MCP integration
|
|
29
|
+
- **faf-mcp** - MCP server implementation
|
|
30
|
+
|
|
31
|
+
## Links
|
|
32
|
+
|
|
33
|
+
- Website: [faf.one](https://faf.one)
|
|
34
|
+
- GitHub: [github.com/Wolfe-Jam/faf](https://github.com/Wolfe-Jam/faf)
|
|
35
|
+
- IANA Registration: [application/vnd.faf+yaml](https://www.iana.org/assignments/media-types/application/vnd.faf+yaml)
|
|
36
|
+
|
|
37
|
+
## Downloads
|
|
38
|
+
|
|
39
|
+
18,700+ combined downloads across the FAF ecosystem.
|
|
40
|
+
|
|
41
|
+
## License
|
|
42
|
+
|
|
43
|
+
MIT
|
|
44
|
+
|
|
45
|
+
---
|
|
46
|
+
|
|
47
|
+
*Created by [@wolfe_jam](https://x.com/wolfe_jam)*
|
package/bin/faf.js
ADDED
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* FAF - Foundational AI-context Format
|
|
5
|
+
* IANA-registered: application/vnd.faf+yaml
|
|
6
|
+
*
|
|
7
|
+
* This is a wrapper that passes through to faf-cli.
|
|
8
|
+
* Install: npm install -g faf
|
|
9
|
+
* Usage: faf init | faf auto | faf bi-sync
|
|
10
|
+
*
|
|
11
|
+
* https://faf.one
|
|
12
|
+
*/
|
|
13
|
+
|
|
14
|
+
require('faf-cli');
|
package/package.json
ADDED
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "faf",
|
|
3
|
+
"version": "1.0.1",
|
|
4
|
+
"description": "FAF - Foundational AI-context Format. IANA-registered standard (application/vnd.faf+yaml). Project DNA for AI.",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"faf",
|
|
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)",
|
|
17
|
+
"license": "MIT",
|
|
18
|
+
"repository": {
|
|
19
|
+
"type": "git",
|
|
20
|
+
"url": "https://github.com/Wolfe-Jam/faf"
|
|
21
|
+
},
|
|
22
|
+
"homepage": "https://faf.one",
|
|
23
|
+
"bugs": {
|
|
24
|
+
"url": "https://github.com/Wolfe-Jam/faf/issues"
|
|
25
|
+
},
|
|
26
|
+
"dependencies": {
|
|
27
|
+
"faf-cli": "latest"
|
|
28
|
+
},
|
|
29
|
+
"bin": {
|
|
30
|
+
"faf": "./bin/faf.js"
|
|
31
|
+
}
|
|
32
|
+
}
|