@chrisdudek/yg 2.12.0 → 4.0.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 +5 -89
- package/dist/bin.js +4376 -3074
- package/graph-schemas/yg-architecture.yaml +12 -0
- package/graph-schemas/yg-aspect.yaml +0 -4
- package/graph-schemas/yg-config.yaml +19 -29
- package/graph-schemas/yg-flow.yaml +1 -2
- package/graph-schemas/yg-node.yaml +13 -17
- package/package.json +13 -10
- package/dist/bin.js.map +0 -1
- package/dist/templates/default-config.ts +0 -36
- package/dist/templates/platform.ts +0 -257
- package/dist/templates/rules.ts +0 -662
package/README.md
CHANGED
|
@@ -1,102 +1,18 @@
|
|
|
1
1
|
# @chrisdudek/yg
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Yggdrasil CLI — continuous architecture enforcement for AI-assisted development.
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
YAML inside `.yggdrasil/`. When an AI agent works on your code, Yggdrasil
|
|
8
|
-
deterministically assembles a precise context package for the exact component
|
|
9
|
-
the agent is modifying.
|
|
5
|
+
See the [main README](../../README.md) for documentation, or visit
|
|
6
|
+
[krzysztofdudek.github.io/Yggdrasil](https://krzysztofdudek.github.io/Yggdrasil/).
|
|
10
7
|
|
|
11
|
-
|
|
12
|
-
builds.
|
|
13
|
-
|
|
14
|
-
## Installation
|
|
15
|
-
|
|
16
|
-
```bash
|
|
17
|
-
npm install -g @chrisdudek/yg
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
Requirements: Node.js 22+
|
|
21
|
-
|
|
22
|
-
## Initialize
|
|
23
|
-
|
|
24
|
-
```bash
|
|
25
|
-
cd your-project
|
|
26
|
-
yg init --platform <platform>
|
|
27
|
-
```
|
|
28
|
-
|
|
29
|
-
Done. Your repository is now self-aware.
|
|
30
|
-
|
|
31
|
-
## Quick Start
|
|
32
|
-
|
|
33
|
-
```bash
|
|
34
|
-
yg init --platform cursor
|
|
35
|
-
yg tree --depth 1
|
|
36
|
-
yg validate
|
|
37
|
-
yg build-context --node orders/order-service
|
|
38
|
-
```
|
|
39
|
-
|
|
40
|
-
## Core Commands
|
|
41
|
-
|
|
42
|
-
**Diagnostics:**
|
|
43
|
-
|
|
44
|
-
- `yg preflight [--quick]` — Unified diagnostic report: drift, status, validation
|
|
45
|
-
|
|
46
|
-
**Reading and analysis:**
|
|
47
|
-
|
|
48
|
-
- `yg build-context --node <path> [--full]` — Assemble context package (YAML structural map + artifact paths; `--full` appends file contents)
|
|
49
|
-
- `yg status` — Graph health summary
|
|
50
|
-
- `yg tree [--root <path>] [--depth N]` — Graph structure as tree
|
|
51
|
-
- `yg owner --file <path>` — Find which graph node owns a source file
|
|
52
|
-
- `yg deps --node <path>` — Forward dependency tree and materialization order
|
|
53
|
-
- `yg impact --node <path> [--simulate]` — Reverse dependencies and context impact
|
|
54
|
-
- `yg select --task <description> [--limit <n>]` — Find graph nodes relevant to a task
|
|
55
|
-
- `yg aspects` — List aspects with metadata (YAML output)
|
|
56
|
-
- `yg flows` — List flows with metadata (YAML output)
|
|
57
|
-
|
|
58
|
-
**Validation and drift:**
|
|
59
|
-
|
|
60
|
-
- `yg validate [--scope all|node-path]` — Structural integrity and completeness
|
|
61
|
-
- `yg drift [--scope all|node-path] [--drifted-only] [--limit <n>]` — Detect graph-to-file divergence
|
|
62
|
-
- `yg drift-sync --node <path> [--recursive]` — Record current file hash after resolving drift
|
|
63
|
-
- `yg drift-sync --all` — Sync all nodes with mappings in one command
|
|
64
|
-
|
|
65
|
-
**Setup:**
|
|
66
|
-
|
|
67
|
-
- `yg init --platform <name>` — Initialize `.yggdrasil/` structure (once per repository)
|
|
68
|
-
- `yg init --platform <name> --upgrade` — Refresh rules only (config and graph stay unchanged)
|
|
69
|
-
|
|
70
|
-
Node paths are relative to `.yggdrasil/model/`. File paths are relative to the
|
|
71
|
-
repository root.
|
|
72
|
-
|
|
73
|
-
## Upgrade
|
|
8
|
+
## Install
|
|
74
9
|
|
|
75
10
|
```bash
|
|
76
11
|
npm install -g @chrisdudek/yg
|
|
77
12
|
cd your-project
|
|
78
|
-
yg init
|
|
13
|
+
yg init
|
|
79
14
|
```
|
|
80
15
|
|
|
81
|
-
`--upgrade` overwrites only the rules file. Your `.yggdrasil/` config and graph
|
|
82
|
-
are not modified.
|
|
83
|
-
|
|
84
|
-
## Supported Platforms
|
|
85
|
-
|
|
86
|
-
| Platform | Init | Rules location |
|
|
87
|
-
| ----------- | -------------------------------- | --------------------------------- |
|
|
88
|
-
| Cursor | `yg init --platform cursor` | `.cursor/rules/yggdrasil.mdc` |
|
|
89
|
-
| Claude Code | `yg init --platform claude-code` | `AGENTS.md` (Yggdrasil section) |
|
|
90
|
-
| Copilot | `yg init --platform copilot` | `.github/copilot-instructions.md` |
|
|
91
|
-
| Cline | `yg init --platform cline` | `.clinerules/yggdrasil.md` |
|
|
92
|
-
| RooCode | `yg init --platform roocode` | `.roo/rules/yggdrasil.md` |
|
|
93
|
-
| Codex | `yg init --platform codex` | `AGENTS.md` (Yggdrasil section) |
|
|
94
|
-
| Windsurf | `yg init --platform windsurf` | `.windsurf/rules/yggdrasil.md` |
|
|
95
|
-
| Aider | `yg init --platform aider` | `.yggdrasil/agent-rules.md` |
|
|
96
|
-
| Gemini CLI | `yg init --platform gemini` | `GEMINI.md` (import) |
|
|
97
|
-
| Amp | `yg init --platform amp` | `AGENTS.md` (import) |
|
|
98
|
-
| Generic | `yg init --platform generic` | `.yggdrasil/agent-rules.md` |
|
|
99
|
-
|
|
100
16
|
## License
|
|
101
17
|
|
|
102
18
|
MIT
|