archik 0.6.7 → 0.6.9
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 +32 -4
- package/dist/cli/archik.mjs +163 -163
- package/dist/ui/assets/index--WU38v9Y.css +1 -0
- package/dist/ui/assets/index-Bz-prNFj.js +219 -0
- package/dist/ui/favicon.svg +10 -7
- package/dist/ui/index.html +2 -2
- package/docs/logo.svg +28 -0
- package/docs/wordmark.svg +23 -0
- package/package.json +11 -1
- package/dist/ui/assets/index-B-QfxZju.css +0 -1
- package/dist/ui/assets/index-BcQOuu98.js +0 -219
package/README.md
CHANGED
|
@@ -1,12 +1,40 @@
|
|
|
1
|
-
|
|
1
|
+
<p align="center">
|
|
2
|
+
<img src="./docs/logo.svg" alt="archik" width="120">
|
|
3
|
+
</p>
|
|
4
|
+
|
|
5
|
+
<h1 align="center">archik</h1>
|
|
6
|
+
|
|
7
|
+
<p align="center">
|
|
8
|
+
<em>The shared vocabulary between you and Claude Code, at the engineering level.</em>
|
|
9
|
+
</p>
|
|
2
10
|
|
|
3
|
-
|
|
11
|
+
[](https://www.npmjs.com/package/archik)
|
|
12
|
+
[](https://github.com/bacharSalleh/archik/actions/workflows/ci.yml)
|
|
13
|
+
[](https://github.com/bacharSalleh/archik/stargazers)
|
|
14
|
+
[](https://www.npmjs.com/package/archik)
|
|
15
|
+
[](./LICENSE)
|
|
16
|
+
[](https://nodejs.org)
|
|
17
|
+
[](https://x.com/bach__92)
|
|
4
18
|
|
|
5
19
|
<p align="center">
|
|
6
|
-
<img src="
|
|
20
|
+
<img src="./docs/hero.svg" alt="Sample Archik diagram of an LLM-assisted support system" width="780">
|
|
7
21
|
</p>
|
|
8
22
|
|
|
9
|
-
|
|
23
|
+
archik gives your project — and the AI editing it — *one file* that
|
|
24
|
+
describes what the system actually looks like. Services, databases,
|
|
25
|
+
queues, agents, LLMs, the edges between them. Plain YAML, schema-
|
|
26
|
+
validated, no coordinates, no proprietary format.
|
|
27
|
+
|
|
28
|
+
Open it in your browser for a live canvas. Render it in CI for a
|
|
29
|
+
self-contained SVG. Install the [Claude Code skill](#for-claude-code--other-llms)
|
|
30
|
+
so the model edits the same file you do — *the diagram and the
|
|
31
|
+
codebase stop drifting because Claude treats the diagram as the
|
|
32
|
+
spec*.
|
|
33
|
+
|
|
34
|
+
If you've ever asked an AI agent "where would I add X?" and watched
|
|
35
|
+
it guess from filenames, archik is the fix: the YAML answers the
|
|
36
|
+
question, and Claude is required to read it before doing structural
|
|
37
|
+
work.
|
|
10
38
|
|
|
11
39
|
## Quickstart
|
|
12
40
|
|