arcane-cli 0.26.1 → 0.26.2
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 +16 -11
- package/dist/assets/.arcane/governance/portable-bootstrap.md +6 -0
- package/dist/assets/.github/prompts/spell-close-session.prompt.md +1 -1
- package/dist/assets/.github/prompts/spell-document.prompt.md +2 -2
- package/dist/assets/.github/prompts/spell-todo.prompt.md +1 -0
- package/package.json +3 -1
package/README.md
CHANGED
|
@@ -30,7 +30,7 @@ npm install -g arcane-cli # then: spell init
|
|
|
30
30
|
|
|
31
31
|
<div align="center">
|
|
32
32
|
|
|
33
|
-
**🔁 opinionated lifecycle** · **📜
|
|
33
|
+
**🔁 opinionated lifecycle** · **📜 38 spells** · **🤖 12 agents** · **⚖️ 23 governance standards** · **📝 markdown-native** · **🔌 any AI client / tracker**
|
|
34
34
|
|
|
35
35
|
</div>
|
|
36
36
|
|
|
@@ -113,22 +113,27 @@ Arcane isn't a prompt snippet — it's a full framework. Everything installs int
|
|
|
113
113
|
|
|
114
114
|
| Layer | What you get |
|
|
115
115
|
| --- | --- |
|
|
116
|
-
| 📜 **Spells** | **
|
|
117
|
-
| ⚖️ **Governance** | **
|
|
116
|
+
| 📜 **Spells** | **38** prompt-driven workflows spanning the entire lifecycle — planning, architecture, implementation, testing, review, shipping, session management, and ops. |
|
|
117
|
+
| ⚖️ **Governance** | **23** battle-tested standards as drop-in templates: git conventions, testing standards, CI/CD, threat model, ADR format, naming, security hardening, and more. |
|
|
118
118
|
| 🤖 **Agents** | **12** ready-made agent personas with roles, clusters, and a gamified autonomy model — assign work and power levels per repo. |
|
|
119
119
|
| 🛠️ **CLI** | `spell init / add / update / status / uninstall` — install by profile or à la carte, and keep everything in sync as new versions ship. |
|
|
120
120
|
|
|
121
|
+
<!-- arcane:start -->
|
|
121
122
|
<details>
|
|
122
|
-
<summary><b>📜 The full spell catalogue (
|
|
123
|
-
|
|
124
|
-
**
|
|
125
|
-
**
|
|
126
|
-
**
|
|
127
|
-
**
|
|
128
|
-
**
|
|
129
|
-
**
|
|
123
|
+
<summary><b>📜 The full spell catalogue (38)</b></summary>
|
|
124
|
+
|
|
125
|
+
**Session** — `open-session` · `close-session` · `commit-work` · `status` · `arcane-version`
|
|
126
|
+
**Capture** — `save-idea` · `todo` · `feedback` · `suggest-feature` · `document` · `brainstorm` · `explain-concept`
|
|
127
|
+
**Delivery** — `create-pull-request` · `sync-pull-request` · `address-review`
|
|
128
|
+
**Review** — `review` · `review-batch`
|
|
129
|
+
**Planning** — `plan` · `architect` · `scope` · `product-review`
|
|
130
|
+
**Build** — `implement` · `test` · `full-cycle` · `bug` · `bump` · `dotnet-expert` · `security-review` · `ship` · `enchant` · `generate-bot-icons` · `make-discoverable` · `scry`
|
|
131
|
+
**Docs** — `adopt-docs`
|
|
132
|
+
**Venture** — `summon-venture` · `manifest`
|
|
133
|
+
**Meta** — `present-arcane` · `check-drift`
|
|
130
134
|
|
|
131
135
|
</details>
|
|
136
|
+
<!-- arcane:end -->
|
|
132
137
|
|
|
133
138
|
<details>
|
|
134
139
|
<summary><b>⚖️ The governance standards (23)</b></summary>
|
|
@@ -54,6 +54,12 @@ Paste this entire file into any AI client (Claude web, ChatGPT, etc.) to give it
|
|
|
54
54
|
- **Project/domain documents:** use explicit descriptive paths such as `docs/`, `security/`, `infrastructure/`, or a configured business root. These add project context alongside framework standards.
|
|
55
55
|
- **Overrides are not yet supported:** editing a managed `.arcane/governance/` standard can be replaced by `arcane update`. Additive project documents are safe; overriding a shipped standard requires the open customization/override model.
|
|
56
56
|
|
|
57
|
+
## Research Reports
|
|
58
|
+
|
|
59
|
+
Research findings (competitive analysis, technical spikes, feasibility studies — the output of the Research & Backlog Analyst role) live at `docs/research/<topic-slug>.md`, one file per report. No dedicated spell produces these: `spell-document` already proposes a target path from project structure and matches its destination directory's existing conventions — point it at `docs/research/` for investigative content, the same way it already proposes `docs/` or `.arcane/governance/` for other document types. The directory is created on first real report, not pre-seeded on `spell init`.
|
|
60
|
+
|
|
61
|
+
Use this repo's standard frontmatter (below) plus one addition: `sources` — a list of what was consulted. Every claim in the body traces back to one of these or is explicitly marked speculative. Structure the body summary-first: a short **Summary** with the key findings, then **Findings** with full detail and inline citations, then an optional **Follow-ups** for anything that should become a TODO item — route those via `spell-todo`, which cross-references the report path. Throughout, distinguish **verified facts**, **reasonable inferences**, and **speculation** explicitly; don't let an inference read as a checked fact.
|
|
62
|
+
|
|
57
63
|
## Documentation Format
|
|
58
64
|
|
|
59
65
|
Every doc uses YAML frontmatter: `title`, `audience` (human/ai/both), `last_updated`, `status` (draft/active/deprecated), `tags`. Use wiki-links (`[[filename]]`) for cross-references.
|
|
@@ -31,7 +31,7 @@ Workflow:
|
|
|
31
31
|
- Decisions made (even implicit ones like naming choices, tool preferences, or workflow patterns).
|
|
32
32
|
- Problems encountered and how they were resolved (troubleshooting).
|
|
33
33
|
- Lessons learned (anything that cost time, surprised the user, or should prevent future mistakes).
|
|
34
|
-
- **Capture tie-in tip:** If this session produced durable analysis worth formalizing (a design, an investigation, a reusable explanation), suggest running `spell-document` before closing so it lands in the right doc. For quick ideas worth keeping but not yet actionable, suggest `spell-save-idea`.
|
|
34
|
+
- **Capture tie-in tip:** If this session produced durable analysis worth formalizing (a design, an investigation, a research finding, a reusable explanation), suggest running `spell-document` before closing so it lands in the right doc — a research finding defaults to `docs/research/<topic-slug>.md` per `portable-bootstrap.md`'s Research Reports convention. For quick ideas worth keeping but not yet actionable, suggest `spell-save-idea`.
|
|
35
35
|
|
|
36
36
|
1b. **Verify in-flight async work before writing any output artifact (EF-21). Enforcement: structured spell gate (ARC-023) — this workflow requires the observable state of every dispatched item before proceeding to step 2.** "I started it" is not "it worked." Before the journal, TODO.md, or the handoff are written, enumerate every piece of asynchronous work dispatched during this session that could still be running or could have failed after being kicked off — CI/CD runs, deployments, package publishes, long-running background tasks, PR checks. For each, **actively check** its current status through whatever means is available (CI provider API/CLI, deployment dashboard, `gh run view`, `az pipelines runs show`, etc.) — attempt the check before reaching for `unverifiable`; that state exists for genuine access limits (no CLI/API access, no credentials, provider outage), not for skipping a check that was merely inconvenient to run. Then classify into exactly one state:
|
|
37
37
|
|
|
@@ -25,8 +25,8 @@ The user's input describes what to capture and where. If no argument was provide
|
|
|
25
25
|
Identify:
|
|
26
26
|
|
|
27
27
|
- **Topics** — what conversation insights to extract (e.g., "naming analysis", "architecture comparison").
|
|
28
|
-
- **Target paths** — where to write (e.g., `docs/...`, `.arcane/governance/...`). If the user gives only topics, propose sensible paths from the project structure.
|
|
29
|
-
- **Document type** — reference doc, decision record, analysis report, inventory, or guide.
|
|
28
|
+
- **Target paths** — where to write (e.g., `docs/...`, `.arcane/governance/...`). If the user gives only topics, propose sensible paths from the project structure. For a research report specifically (cited investigation, competitive analysis, feasibility study), default to `docs/research/<topic-slug>.md` per `portable-bootstrap.md`'s Research Reports convention.
|
|
29
|
+
- **Document type** — reference doc, decision record, analysis report, research report, inventory, or guide.
|
|
30
30
|
|
|
31
31
|
## Step 2 — Extract from Conversation
|
|
32
32
|
|
|
@@ -118,6 +118,7 @@ Determine the target file(s) for each item:
|
|
|
118
118
|
| Speculative idea or future-facing concept | `TODO.md` under `## Product Ideas` or the best matching section |
|
|
119
119
|
| ADR candidate | `DECISIONS.md` — flag it as pending, do not write the full ADR yet |
|
|
120
120
|
| Journal-worthy context | `journal/` — propose a filename with today's date slug, do not create the file yet |
|
|
121
|
+
| Finding sourced from a research report | `TODO.md` under the matching section — cross-reference the report path (e.g., `— see docs/research/<slug>.md`) |
|
|
121
122
|
| Business-specific execution item | Both `TODO.md` AND the relevant `{BUSINESS_ROOT}/<name>/overview.md` reference section |
|
|
122
123
|
|
|
123
124
|
## Step 4 — Show Proposal
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "arcane-cli",
|
|
3
|
-
"version": "0.26.
|
|
3
|
+
"version": "0.26.2",
|
|
4
4
|
"description": "Arcane framework CLI — scaffold and manage governance files in consuming repositories",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"arcane",
|
|
@@ -42,6 +42,8 @@
|
|
|
42
42
|
"typecheck": "tsc --noEmit",
|
|
43
43
|
"check:self-host-parity": "tsx scripts/self-host-parity.ts --check",
|
|
44
44
|
"fix:self-host-parity": "tsx scripts/self-host-parity.ts --fix",
|
|
45
|
+
"check:spell-catalog": "tsx scripts/spell-catalog.ts --check",
|
|
46
|
+
"fix:spell-catalog": "tsx scripts/spell-catalog.ts --fix",
|
|
45
47
|
"check:adr-references": "tsx scripts/check-distributed-adr-references.ts",
|
|
46
48
|
"check:version-bump": "tsx scripts/check-version-bump.ts",
|
|
47
49
|
"check:review-round": "tsx scripts/check-review-round.ts",
|