adrien 0.0.0-stage → 0.1.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.
Files changed (4) hide show
  1. package/LICENSE +661 -0
  2. package/README.md +92 -2
  3. package/dist/index.js +2301 -0
  4. package/package.json +45 -4
package/README.md CHANGED
@@ -1,3 +1,93 @@
1
- # Temporary Holding Version
1
+ # Adrien
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ Architecture decisions for developers **and their AI agents**. (Yes, the name is a nod to ADR.)
4
+
5
+ Decisions get made in merge-request threads, chat and tickets, and then they are lost. Nobody has an overview, nothing
6
+ gets updated, and AI coding agents never see the _why_ behind the code, so they happily "fix" something that was written
7
+ that way on purpose.
8
+
9
+ Adrien keeps your Architecture Decision Records (ADRs) as plain markdown in your own git repos and answers one question
10
+ for people and agents alike: **which decisions govern the code I am about to change, and why?**
11
+
12
+ - **Plain files, no lock-in.** ADRs are markdown with a little frontmatter. Plain MADR, log4brains and adr-tools files
13
+ are read as they are.
14
+ - **Many repos, one log per product.** A product can span many repos (microservices, micro-frontends). Its decisions
15
+ live in one log, and each ADR names the files it governs.
16
+ - **The merge request is the approval.** A decision is binding only once it is `accepted` on the default branch.
17
+ Agents and developers can propose; architects approve by merging.
18
+ - **Built for agents.** An MCP server hands an agent the governing decisions and their one-line `review_rule` before it
19
+ edits, and lets it propose new ones. It can never accept anything itself.
20
+ - **Informs, never blocks.** `adrien check` is CI-ready, and flags problems rather than gating your pipeline.
21
+
22
+ ## Install
23
+
24
+ Needs Node 22.13 or later.
25
+
26
+ ```sh
27
+ npx adrien --help # or: npm install -g adrien
28
+ ```
29
+
30
+ ## Quickstart
31
+
32
+ **1. Create the log**, in the repo that will hold your decisions (or inside a monorepo):
33
+
34
+ ```sh
35
+ adrien init --product acme
36
+ adrien new "Store invoices in Postgres" --tags backend,database
37
+ adrien check
38
+ ```
39
+
40
+ `init` prints the two things to set up on your git host: `CODEOWNERS` for the ADR folder, and required code-owner
41
+ approval on the default branch.
42
+
43
+ **2. Link each code repo** to the log, and tell agents about it:
44
+
45
+ ```sh
46
+ adrien init --code-repo --log ../decisions # or a git URL
47
+ adrien init --agents # adds a block to AGENTS.md
48
+ ```
49
+
50
+ **3. Ask what governs a file:**
51
+
52
+ ```sh
53
+ adrien for src/Invoices/Invoice.ts
54
+ ```
55
+
56
+ ```text
57
+ src/Invoices/Invoice.ts [billing-service]
58
+ ADR-0007 BINDING Store invoices in Postgres
59
+ rule: Invoices are read and written through the repository, never the document client.
60
+ ```
61
+
62
+ **4. Approve by merging.** `adrien accept ADR-0007`, commit, and merge the merge request.
63
+
64
+ ## Use it from an AI agent
65
+
66
+ ```sh
67
+ claude mcp add adrien -- npx -y adrien mcp
68
+ ```
69
+
70
+ Run from the code repo (or log repo). Any MCP client that speaks stdio works the same way. The agent gets six tools:
71
+ `adr_for_files`, `adr_search`, `adr_list`, `adr_get`, `adr_propose` and `adr_propose_change`.
72
+
73
+ ## Commands
74
+
75
+ `init`, `new`, `list`, `show`, `search`, `for`, `check`, `lint`, `export`, `accept`, `status`, `supersede`, `renumber`, `sync`, `mcp`.
76
+ Run `adrien <command> --help`. Add `--json` for machine-readable output.
77
+
78
+ ## Documentation
79
+
80
+ The [format reference](https://github.com/moumine9/adrien/blob/main/docs/format.md) covers the ADR format, the config
81
+ files, anchors, and how approval works.
82
+
83
+ Adrien keeps its own architecture decisions in
84
+ [`docs/decisions`](https://github.com/moumine9/adrien/tree/main/docs/decisions), and its CI runs `adrien check` on them.
85
+
86
+ ## Status
87
+
88
+ Early. The local core (format, CLI, MCP server) is what exists today. Next: a server and API, a web UI, and detection
89
+ of decisions hiding in merge requests, chat and tickets.
90
+
91
+ ## License
92
+
93
+ [AGPL-3.0](LICENSE)