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 CHANGED
@@ -1,12 +1,40 @@
1
- # Archik
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
- > An architecture diagram tool where the file is the source of truth — and Claude can edit it alongside you.
11
+ [![npm version](https://badge.fury.io/js/archik.svg)](https://www.npmjs.com/package/archik)
12
+ [![CI](https://github.com/bacharSalleh/archik/actions/workflows/ci.yml/badge.svg)](https://github.com/bacharSalleh/archik/actions/workflows/ci.yml)
13
+ [![GitHub Repo stars](https://img.shields.io/github/stars/bacharSalleh/archik)](https://github.com/bacharSalleh/archik/stargazers)
14
+ [![NPM Downloads](https://img.shields.io/npm/dm/archik)](https://www.npmjs.com/package/archik)
15
+ [![License](https://img.shields.io/npm/l/archik?color=blue)](./LICENSE)
16
+ [![Node](https://img.shields.io/node/v/archik?color=339933&logo=node.js&logoColor=white)](https://nodejs.org)
17
+ [![Twitter Follow](https://img.shields.io/twitter/follow/bach__92?style=social)](https://x.com/bach__92)
4
18
 
5
19
  <p align="center">
6
- <img src="https://cdn.jsdelivr.net/npm/archik/docs/hero.svg" alt="Sample Archik diagram of an LLM-assisted support system" width="780">
20
+ <img src="./docs/hero.svg" alt="Sample Archik diagram of an LLM-assisted support system" width="780">
7
21
  </p>
8
22
 
9
- You write a small YAML file describing your nodes (services, databases, queues, agents, LLMs, …) and the edges between them. Archik gives you a live browser canvas, a CLI for CI, and an installable AI skill so Claude Code understands your architecture file the same way you do — no proprietary format, no coordinates in the YAML, no manual layout.
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