archik 0.6.19 → 0.7.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/.claude/commands/archik/accept.md +21 -0
- package/.claude/commands/archik/describe.md +28 -0
- package/.claude/commands/archik/dev.md +24 -0
- package/.claude/commands/archik/reject.md +16 -0
- package/.claude/commands/archik/suggest.md +73 -0
- package/.claude/skills/archik/SKILL.md +214 -101
- package/README.md +27 -12
- package/dist/cli/archik.mjs +368 -316
- package/dist/ui/assets/{index-Ds3t5e5F.js → index-BAIgFELp.js} +114 -114
- package/dist/ui/assets/index-UZ_JijeQ.css +1 -0
- package/dist/ui/index.html +2 -2
- package/package.json +6 -5
- package/dist/ui/assets/index--WU38v9Y.css +0 -1
package/README.md
CHANGED
|
@@ -90,30 +90,36 @@ No `x` / `y` / `width` — layout is computed by [ELK](https://eclipse.dev/elk/)
|
|
|
90
90
|
- **12 relationships** with distinct visual styling — `http_call`, `invokes`, `reads`, `writes`, `publishes`, `subscribes`, `streams_to`, `routes_to`, `implements`, `depends_on`, `has_a`, `uses`.
|
|
91
91
|
- **Drag-to-connect, multi-select, undo/redo, compact view, themed (dark / light), notes per node, color overrides on edges.**
|
|
92
92
|
- **CI-ready CLI** — `validate`, `render` (headless SVG), `watch`, `check` (drift between YAML and source dirs).
|
|
93
|
-
- **AI skill** — `archik skill --user` installs
|
|
93
|
+
- **AI skill + slash commands** — `archik skill --user` installs the Claude Code skill; `archik commands --user` installs `/archik:suggest`, `/archik:accept`, `/archik:reject`, `/archik:describe`, and `/archik:dev` so Claude drives the diagram entirely through the CLI.
|
|
94
94
|
|
|
95
95
|
## For Claude Code & other LLMs
|
|
96
96
|
|
|
97
97
|
The whole reason Archik uses YAML instead of a binary format: **the file is the shared map between you and the model**. Run:
|
|
98
98
|
|
|
99
99
|
```bash
|
|
100
|
-
archik skill --user # install
|
|
100
|
+
archik skill --user # install the skill into ~/.claude/skills
|
|
101
|
+
archik commands --user # install the /archik:* slash commands into ~/.claude/commands
|
|
101
102
|
```
|
|
102
103
|
|
|
103
|
-
|
|
104
|
+
(Or just `archik init` in a fresh project — both land automatically.)
|
|
104
105
|
|
|
105
|
-
|
|
106
|
-
2. **Propose** YAML updates whenever new work introduces or rewires components.
|
|
107
|
-
3. **Run `archik validate`** after every edit to fail fast on schema errors.
|
|
106
|
+
The skill enforces a hard rule: **Claude interacts with archik only through the `npx archik` CLI** — never `Read`, `Write`, or `Edit` on a YAML directly. Queries go through `npx archik q`, suggestions through `npx archik suggest set`, lifecycle through `npx archik suggest accept | reject`. The user owns the file; the CLI is the contract.
|
|
108
107
|
|
|
109
|
-
|
|
108
|
+
Day-to-day this looks like:
|
|
109
|
+
|
|
110
|
+
```
|
|
111
|
+
/archik:suggest add a payments worker that subscribes to the orders queue
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
Claude grounds itself with `npx archik q stats`, drafts a full proposal in a temp file, runs `npx archik suggest set` to stage it as the canonical sidecar, and surfaces the canvas URL so you can review the diff overlay and Accept/Reject in the browser. No manual YAML edits, no chance of the canvas and the file disagreeing.
|
|
110
115
|
|
|
111
116
|
## Commands
|
|
112
117
|
|
|
113
118
|
```
|
|
114
119
|
archik init [path] Scaffold a starter .archik/main.archik.yaml
|
|
115
|
-
(also installs the Claude skill by default)
|
|
120
|
+
(also installs the Claude skill + /archik:* slash commands by default)
|
|
116
121
|
--no-skill skip installing the Claude skill
|
|
122
|
+
--no-commands skip installing the /archik:* slash commands
|
|
117
123
|
|
|
118
124
|
archik dev [path] Open the canvas in your browser (foreground, Ctrl+C to stop)
|
|
119
125
|
archik start [path] Same as dev, but detached — prompt returns immediately
|
|
@@ -129,11 +135,23 @@ archik render [path] Render to a self-contained SVG file
|
|
|
129
135
|
--out <file> output path (default: diagram.svg)
|
|
130
136
|
--theme <name> "dark" (default) or "light"
|
|
131
137
|
archik watch [path] Re-render to SVG on every file change (Ctrl+C to stop)
|
|
132
|
-
|
|
138
|
+
|
|
139
|
+
archik suggest [sub] Manage Claude's pending architecture suggestion
|
|
140
|
+
show summarise the pending sidecar (default; --json supported)
|
|
141
|
+
set <draft> validate a draft YAML and stage it as the sidecar
|
|
142
|
+
--note '<text>' set metadata.suggestion.note
|
|
143
|
+
--main <path> override main file detection
|
|
144
|
+
--json structured output
|
|
145
|
+
- read draft from stdin
|
|
146
|
+
accept apply the sidecar over the main file
|
|
147
|
+
reject discard the sidecar
|
|
133
148
|
|
|
134
149
|
archik skill Install the Claude skill for AI editing
|
|
135
150
|
--user install into ~/.claude/skills (all projects)
|
|
136
151
|
--force overwrite an existing skill
|
|
152
|
+
archik commands Install the /archik:* slash commands for Claude Code
|
|
153
|
+
--user install into ~/.claude/commands (all projects)
|
|
154
|
+
--force overwrite existing commands
|
|
137
155
|
```
|
|
138
156
|
|
|
139
157
|
Without a `[path]` argument, archik resolves the file in this order:
|
|
@@ -153,9 +171,6 @@ archik validate
|
|
|
153
171
|
|
|
154
172
|
# Generate a committable SVG of your architecture for the docs site
|
|
155
173
|
archik render --theme light --out docs/architecture.svg
|
|
156
|
-
|
|
157
|
-
# Warn when nodes don't have a matching source folder under src/, services/, packages/, or apps/
|
|
158
|
-
archik check
|
|
159
174
|
```
|
|
160
175
|
|
|
161
176
|
## Schema
|