recall-os 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.
- package/LICENSE +21 -0
- package/README.md +213 -0
- package/dist/cli.d.ts +1 -0
- package/dist/cli.js +5213 -0
- package/dist/cli.js.map +1 -0
- package/dist/index.d.ts +16 -0
- package/dist/index.js +5212 -0
- package/dist/index.js.map +1 -0
- package/examples/generated-flutter/.recall/config.json +17 -0
- package/examples/generated-flutter/.recall/hooks/pre-commit +9 -0
- package/examples/generated-flutter/AGENTS.md +15 -0
- package/examples/generated-flutter/CLAUDE.md +7 -0
- package/examples/generated-flutter/README.md +10 -0
- package/examples/generated-flutter/docs/00-product/BRD.md +9 -0
- package/examples/generated-flutter/docs/00-product/PRD.md +13 -0
- package/examples/generated-flutter/docs/10-architecture/ARCHITECTURE.md +11 -0
- package/examples/generated-flutter/docs/10-architecture/FILE_WRITE_POLICY.md +8 -0
- package/examples/generated-flutter/docs/10-architecture/MEMORY_ENGINE.md +16 -0
- package/examples/generated-flutter/docs/20-security/SECURITY_MODEL.md +11 -0
- package/examples/generated-flutter/docs/20-security/THREAT_MODEL.md +7 -0
- package/examples/generated-flutter/docs/30-modules/README.md +17 -0
- package/examples/generated-flutter/docs/40-features/README.md +22 -0
- package/examples/generated-flutter/docs/50-quality/QUALITY_GATES.md +11 -0
- package/examples/generated-flutter/docs/50-quality/TESTING_STRATEGY.md +5 -0
- package/examples/generated-flutter/docs/60-engineering/AI_AGENT_RULES.md +6 -0
- package/examples/generated-flutter/docs/60-engineering/ENGINEERING_STANDARDS.md +11 -0
- package/examples/generated-flutter/docs/adrs/README.md +5 -0
- package/examples/generated-flutter/docs/adrs/proposed/ADR-PROPOSED-flutter-platform.md +10 -0
- package/examples/generated-flutter/docs/ai/AI_AGENTS_SKILLS_MCP_STRATEGY.md +7 -0
- package/examples/generated-flutter/docs/ai/MCP_STRATEGY.md +6 -0
- package/examples/generated-flutter/docs/ai/RECALL_COMMANDS.md +133 -0
- package/examples/generated-flutter/docs/ai/presets/flutter-guidance.md +4 -0
- package/examples/generated-generic/.recall/config.json +17 -0
- package/examples/generated-generic/.recall/hooks/pre-commit +9 -0
- package/examples/generated-generic/AGENTS.md +15 -0
- package/examples/generated-generic/CLAUDE.md +7 -0
- package/examples/generated-generic/README.md +10 -0
- package/examples/generated-generic/docs/00-product/BRD.md +9 -0
- package/examples/generated-generic/docs/00-product/PRD.md +13 -0
- package/examples/generated-generic/docs/10-architecture/ARCHITECTURE.md +11 -0
- package/examples/generated-generic/docs/10-architecture/FILE_WRITE_POLICY.md +8 -0
- package/examples/generated-generic/docs/10-architecture/MEMORY_ENGINE.md +16 -0
- package/examples/generated-generic/docs/20-security/SECURITY_MODEL.md +11 -0
- package/examples/generated-generic/docs/20-security/THREAT_MODEL.md +7 -0
- package/examples/generated-generic/docs/30-modules/README.md +17 -0
- package/examples/generated-generic/docs/40-features/README.md +22 -0
- package/examples/generated-generic/docs/50-quality/QUALITY_GATES.md +11 -0
- package/examples/generated-generic/docs/50-quality/TESTING_STRATEGY.md +5 -0
- package/examples/generated-generic/docs/60-engineering/AI_AGENT_RULES.md +6 -0
- package/examples/generated-generic/docs/60-engineering/ENGINEERING_STANDARDS.md +11 -0
- package/examples/generated-generic/docs/adrs/README.md +5 -0
- package/examples/generated-generic/docs/ai/AI_AGENTS_SKILLS_MCP_STRATEGY.md +7 -0
- package/examples/generated-generic/docs/ai/MCP_STRATEGY.md +6 -0
- package/examples/generated-generic/docs/ai/RECALL_COMMANDS.md +133 -0
- package/examples/generated-generic/docs/ai/presets/generic-guidance.md +3 -0
- package/examples/generated-ios-swift/.recall/config.json +17 -0
- package/examples/generated-ios-swift/.recall/hooks/pre-commit +9 -0
- package/examples/generated-ios-swift/AGENTS.md +15 -0
- package/examples/generated-ios-swift/CLAUDE.md +7 -0
- package/examples/generated-ios-swift/README.md +10 -0
- package/examples/generated-ios-swift/docs/00-product/BRD.md +9 -0
- package/examples/generated-ios-swift/docs/00-product/PRD.md +13 -0
- package/examples/generated-ios-swift/docs/10-architecture/ARCHITECTURE.md +11 -0
- package/examples/generated-ios-swift/docs/10-architecture/FILE_WRITE_POLICY.md +8 -0
- package/examples/generated-ios-swift/docs/10-architecture/MEMORY_ENGINE.md +16 -0
- package/examples/generated-ios-swift/docs/20-security/SECURITY_MODEL.md +11 -0
- package/examples/generated-ios-swift/docs/20-security/THREAT_MODEL.md +7 -0
- package/examples/generated-ios-swift/docs/30-modules/README.md +17 -0
- package/examples/generated-ios-swift/docs/40-features/README.md +22 -0
- package/examples/generated-ios-swift/docs/50-quality/QUALITY_GATES.md +11 -0
- package/examples/generated-ios-swift/docs/50-quality/TESTING_STRATEGY.md +5 -0
- package/examples/generated-ios-swift/docs/60-engineering/AI_AGENT_RULES.md +6 -0
- package/examples/generated-ios-swift/docs/60-engineering/ENGINEERING_STANDARDS.md +11 -0
- package/examples/generated-ios-swift/docs/adrs/README.md +5 -0
- package/examples/generated-ios-swift/docs/adrs/proposed/ADR-PROPOSED-ios-swift-architecture-mvvm.md +23 -0
- package/examples/generated-ios-swift/docs/adrs/proposed/ADR-PROPOSED-ios-swift-concurrency-async.md +23 -0
- package/examples/generated-ios-swift/docs/adrs/proposed/ADR-PROPOSED-ios-swift-persistence-swiftdata.md +23 -0
- package/examples/generated-ios-swift/docs/adrs/proposed/ADR-PROPOSED-ios-swift-platform.md +24 -0
- package/examples/generated-ios-swift/docs/adrs/proposed/ADR-PROPOSED-ios-swift-ui-swiftui.md +23 -0
- package/examples/generated-ios-swift/docs/ai/AI_AGENTS_SKILLS_MCP_STRATEGY.md +7 -0
- package/examples/generated-ios-swift/docs/ai/MCP_STRATEGY.md +6 -0
- package/examples/generated-ios-swift/docs/ai/RECALL_COMMANDS.md +133 -0
- package/examples/generated-ios-swift/docs/ai/presets/ios-swift-guidance.md +30 -0
- package/examples/generated-kotlin-android/.recall/config.json +17 -0
- package/examples/generated-kotlin-android/.recall/hooks/pre-commit +9 -0
- package/examples/generated-kotlin-android/AGENTS.md +15 -0
- package/examples/generated-kotlin-android/CLAUDE.md +7 -0
- package/examples/generated-kotlin-android/README.md +11 -0
- package/examples/generated-kotlin-android/docs/00-product/BRD.md +9 -0
- package/examples/generated-kotlin-android/docs/00-product/PRD.md +13 -0
- package/examples/generated-kotlin-android/docs/10-architecture/ARCHITECTURE.md +11 -0
- package/examples/generated-kotlin-android/docs/10-architecture/FILE_WRITE_POLICY.md +8 -0
- package/examples/generated-kotlin-android/docs/10-architecture/MEMORY_ENGINE.md +16 -0
- package/examples/generated-kotlin-android/docs/20-security/SECURITY_MODEL.md +11 -0
- package/examples/generated-kotlin-android/docs/20-security/THREAT_MODEL.md +7 -0
- package/examples/generated-kotlin-android/docs/30-modules/README.md +17 -0
- package/examples/generated-kotlin-android/docs/40-features/README.md +22 -0
- package/examples/generated-kotlin-android/docs/50-quality/QUALITY_GATES.md +11 -0
- package/examples/generated-kotlin-android/docs/50-quality/TESTING_STRATEGY.md +5 -0
- package/examples/generated-kotlin-android/docs/60-engineering/AI_AGENT_RULES.md +6 -0
- package/examples/generated-kotlin-android/docs/60-engineering/ENGINEERING_STANDARDS.md +11 -0
- package/examples/generated-kotlin-android/docs/adrs/README.md +5 -0
- package/examples/generated-kotlin-android/docs/adrs/proposed/ADR-PROPOSED-kotlin-android-architecture-mvvm.md +23 -0
- package/examples/generated-kotlin-android/docs/adrs/proposed/ADR-PROPOSED-kotlin-android-async-coroutines.md +23 -0
- package/examples/generated-kotlin-android/docs/adrs/proposed/ADR-PROPOSED-kotlin-android-di-hilt.md +23 -0
- package/examples/generated-kotlin-android/docs/adrs/proposed/ADR-PROPOSED-kotlin-android-persistence-room.md +23 -0
- package/examples/generated-kotlin-android/docs/adrs/proposed/ADR-PROPOSED-kotlin-android-platform.md +24 -0
- package/examples/generated-kotlin-android/docs/adrs/proposed/ADR-PROPOSED-kotlin-android-ui-compose.md +23 -0
- package/examples/generated-kotlin-android/docs/ai/AI_AGENTS_SKILLS_MCP_STRATEGY.md +7 -0
- package/examples/generated-kotlin-android/docs/ai/MCP_STRATEGY.md +6 -0
- package/examples/generated-kotlin-android/docs/ai/RECALL_COMMANDS.md +133 -0
- package/examples/generated-kotlin-android/docs/ai/presets/kotlin-android-guidance.md +30 -0
- package/examples/generated-nextjs/.recall/config.json +17 -0
- package/examples/generated-nextjs/.recall/hooks/pre-commit +9 -0
- package/examples/generated-nextjs/AGENTS.md +15 -0
- package/examples/generated-nextjs/CLAUDE.md +7 -0
- package/examples/generated-nextjs/README.md +10 -0
- package/examples/generated-nextjs/docs/00-product/BRD.md +9 -0
- package/examples/generated-nextjs/docs/00-product/PRD.md +13 -0
- package/examples/generated-nextjs/docs/10-architecture/ARCHITECTURE.md +11 -0
- package/examples/generated-nextjs/docs/10-architecture/FILE_WRITE_POLICY.md +8 -0
- package/examples/generated-nextjs/docs/10-architecture/MEMORY_ENGINE.md +16 -0
- package/examples/generated-nextjs/docs/20-security/SECURITY_MODEL.md +11 -0
- package/examples/generated-nextjs/docs/20-security/THREAT_MODEL.md +7 -0
- package/examples/generated-nextjs/docs/30-modules/README.md +17 -0
- package/examples/generated-nextjs/docs/40-features/README.md +22 -0
- package/examples/generated-nextjs/docs/50-quality/QUALITY_GATES.md +11 -0
- package/examples/generated-nextjs/docs/50-quality/TESTING_STRATEGY.md +5 -0
- package/examples/generated-nextjs/docs/60-engineering/AI_AGENT_RULES.md +6 -0
- package/examples/generated-nextjs/docs/60-engineering/ENGINEERING_STANDARDS.md +11 -0
- package/examples/generated-nextjs/docs/adrs/README.md +5 -0
- package/examples/generated-nextjs/docs/adrs/proposed/ADR-PROPOSED-nextjs-data-layer.md +23 -0
- package/examples/generated-nextjs/docs/adrs/proposed/ADR-PROPOSED-nextjs-framework.md +24 -0
- package/examples/generated-nextjs/docs/adrs/proposed/ADR-PROPOSED-nextjs-routing-app-router.md +23 -0
- package/examples/generated-nextjs/docs/adrs/proposed/ADR-PROPOSED-nextjs-styling-tailwind.md +23 -0
- package/examples/generated-nextjs/docs/adrs/proposed/ADR-PROPOSED-nextjs-testing.md +23 -0
- package/examples/generated-nextjs/docs/ai/AI_AGENTS_SKILLS_MCP_STRATEGY.md +7 -0
- package/examples/generated-nextjs/docs/ai/MCP_STRATEGY.md +6 -0
- package/examples/generated-nextjs/docs/ai/RECALL_COMMANDS.md +133 -0
- package/examples/generated-nextjs/docs/ai/presets/nextjs-guidance.md +30 -0
- package/examples/generated-python-fastapi/.recall/config.json +17 -0
- package/examples/generated-python-fastapi/.recall/hooks/pre-commit +9 -0
- package/examples/generated-python-fastapi/AGENTS.md +15 -0
- package/examples/generated-python-fastapi/CLAUDE.md +7 -0
- package/examples/generated-python-fastapi/README.md +11 -0
- package/examples/generated-python-fastapi/docs/00-product/BRD.md +9 -0
- package/examples/generated-python-fastapi/docs/00-product/PRD.md +13 -0
- package/examples/generated-python-fastapi/docs/10-architecture/ARCHITECTURE.md +11 -0
- package/examples/generated-python-fastapi/docs/10-architecture/FILE_WRITE_POLICY.md +8 -0
- package/examples/generated-python-fastapi/docs/10-architecture/MEMORY_ENGINE.md +16 -0
- package/examples/generated-python-fastapi/docs/20-security/SECURITY_MODEL.md +11 -0
- package/examples/generated-python-fastapi/docs/20-security/THREAT_MODEL.md +7 -0
- package/examples/generated-python-fastapi/docs/30-modules/README.md +17 -0
- package/examples/generated-python-fastapi/docs/40-features/README.md +22 -0
- package/examples/generated-python-fastapi/docs/50-quality/QUALITY_GATES.md +11 -0
- package/examples/generated-python-fastapi/docs/50-quality/TESTING_STRATEGY.md +5 -0
- package/examples/generated-python-fastapi/docs/60-engineering/AI_AGENT_RULES.md +6 -0
- package/examples/generated-python-fastapi/docs/60-engineering/ENGINEERING_STANDARDS.md +11 -0
- package/examples/generated-python-fastapi/docs/adrs/README.md +5 -0
- package/examples/generated-python-fastapi/docs/adrs/proposed/ADR-PROPOSED-python-fastapi-cache-redis.md +23 -0
- package/examples/generated-python-fastapi/docs/adrs/proposed/ADR-PROPOSED-python-fastapi-database-postgres.md +23 -0
- package/examples/generated-python-fastapi/docs/adrs/proposed/ADR-PROPOSED-python-fastapi-framework.md +23 -0
- package/examples/generated-python-fastapi/docs/adrs/proposed/ADR-PROPOSED-python-fastapi-testing-pytest.md +23 -0
- package/examples/generated-python-fastapi/docs/adrs/proposed/ADR-PROPOSED-python-fastapi-validation-pydantic.md +23 -0
- package/examples/generated-python-fastapi/docs/ai/AI_AGENTS_SKILLS_MCP_STRATEGY.md +7 -0
- package/examples/generated-python-fastapi/docs/ai/MCP_STRATEGY.md +6 -0
- package/examples/generated-python-fastapi/docs/ai/RECALL_COMMANDS.md +133 -0
- package/examples/generated-python-fastapi/docs/ai/presets/python-fastapi-guidance.md +31 -0
- package/package.json +65 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Recall OS contributors
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,213 @@
|
|
|
1
|
+
# Recall OS
|
|
2
|
+
|
|
3
|
+
**Durable, AI-ready engineering memory for your repository — and a deterministic `doctor` that
|
|
4
|
+
proves it stays healthy.**
|
|
5
|
+
|
|
6
|
+

|
|
7
|
+

|
|
8
|
+

|
|
9
|
+

|
|
10
|
+

|
|
11
|
+
|
|
12
|
+
Recall OS is a local-first CLI that turns a repository into the source of truth for **why** it is
|
|
13
|
+
built the way it is. It creates structured, reviewable memory — product intent, architecture
|
|
14
|
+
decisions, module ownership, testing and security expectations, AI agent rules — and then
|
|
15
|
+
**validates** that memory with `recall doctor`. Architecture-neutral. No network, no telemetry, no
|
|
16
|
+
code generation.
|
|
17
|
+
|
|
18
|
+
[Install](#install) · [Quickstart](#quickstart) · [Commands](#commands) ·
|
|
19
|
+
[What Doctor Checks](#what-doctor-checks) · [Presets](#presets) · [Contributing](CONTRIBUTING.md)
|
|
20
|
+
|
|
21
|
+
---
|
|
22
|
+
|
|
23
|
+
AI can write code fast, but its context is temporary — it forgets decisions, compacts conversations,
|
|
24
|
+
and drifts from earlier intent. Git records **what** changed. Recall OS records **why**, in a form
|
|
25
|
+
humans and agents can re-read and validate before and after work.
|
|
26
|
+
|
|
27
|
+
```txt
|
|
28
|
+
What are we building? Why did we decide this?
|
|
29
|
+
What must not drift? What evidence proves this work is complete?
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
When these questions live in the repository instead of a chat window, the repository can answer
|
|
33
|
+
them.
|
|
34
|
+
|
|
35
|
+
## Why Recall OS
|
|
36
|
+
|
|
37
|
+
- **Memory that outlives the conversation.** Decisions, constraints, and ownership are committed to
|
|
38
|
+
the repo, not trapped in an agent's context window.
|
|
39
|
+
- **A gate, not just docs.** `recall doctor` is deterministic and returns an exit code, so "is this
|
|
40
|
+
work actually finished and consistent?" becomes a check you can run in a hook or CI.
|
|
41
|
+
- **Architecture-neutral by design.** Recall OS records and protects _your_ decisions. It never
|
|
42
|
+
silently picks a framework, database, or pattern for you.
|
|
43
|
+
- **Local-first and private.** No network calls, no telemetry, no AI API calls, no remote templates.
|
|
44
|
+
It runs entirely on your machine.
|
|
45
|
+
- **Safe by default.** Non-destructive writes, path-traversal and symlink protection, and a refusal
|
|
46
|
+
to overwrite an existing installation without explicit intent.
|
|
47
|
+
|
|
48
|
+
## Install
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
# Local development
|
|
52
|
+
pnpm install
|
|
53
|
+
pnpm build
|
|
54
|
+
node dist/cli.js --help
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
```bash
|
|
58
|
+
# Once published to npm
|
|
59
|
+
npm install -g recall-os
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
## Quickstart
|
|
63
|
+
|
|
64
|
+
```bash
|
|
65
|
+
# 1. Create repository memory (architecture-neutral, or pick an opinion pack)
|
|
66
|
+
recall init
|
|
67
|
+
recall init --preset kotlin-android # optional, proposes stack decisions
|
|
68
|
+
|
|
69
|
+
# 2. Capture intent and decisions as you work
|
|
70
|
+
recall feature create checkout
|
|
71
|
+
recall adr create payment-provider
|
|
72
|
+
recall module create billing
|
|
73
|
+
|
|
74
|
+
# 3. Validate the memory is healthy and complete
|
|
75
|
+
recall doctor
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
`recall init` also generates a tracked pre-commit hook at `.recall/hooks/pre-commit` that runs
|
|
79
|
+
`recall doctor` plus any gates you configure. Enable it once per clone — Recall OS proposes the
|
|
80
|
+
command but never runs it for you:
|
|
81
|
+
|
|
82
|
+
```bash
|
|
83
|
+
git config core.hooksPath .recall/hooks
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
## Commands
|
|
87
|
+
|
|
88
|
+
| Command | Purpose |
|
|
89
|
+
| ------------------------------ | ----------------------------------------------------------- |
|
|
90
|
+
| `recall init` | Create neutral repository memory (and a pre-commit hook). |
|
|
91
|
+
| `recall init --preset <id>` | Add an opinion pack: rich guidance and proposed ADRs. |
|
|
92
|
+
| `recall adopt` | Inspect an existing repo and propose reviewable memory. |
|
|
93
|
+
| `recall preset list` | List built-in presets. |
|
|
94
|
+
| `recall feature create <name>` | Scaffold feature memory (PRD, acceptance, tests, review). |
|
|
95
|
+
| `recall adr create <title>` | Create a proposed architecture decision record. |
|
|
96
|
+
| `recall adr accept <name>` | Promote a proposed ADR to accepted source-of-truth. |
|
|
97
|
+
| `recall module create <name>` | Scaffold module memory (ownership, boundaries, tests). |
|
|
98
|
+
| `recall skill create <name>` | Generate a portable AI agent skill (Claude + Agent Skills). |
|
|
99
|
+
| `recall mcp add <server>` | Generate offline, proposed memory for an MCP server. |
|
|
100
|
+
| `recall doctor` | Validate memory health, evidence, and drift. |
|
|
101
|
+
|
|
102
|
+
## What Doctor Checks
|
|
103
|
+
|
|
104
|
+
`recall doctor` is the part that makes Recall OS more than a template. Every check is deterministic,
|
|
105
|
+
local, and read-only.
|
|
106
|
+
|
|
107
|
+
| Category | Detects | Severity |
|
|
108
|
+
| ------------------- | -------------------------------------------------------------------------- | ------------ |
|
|
109
|
+
| Structure | Missing config, required docs, or feature / module / ADR sections | error |
|
|
110
|
+
| Completion evidence | A feature marked complete with review pending or no test / result evidence | error |
|
|
111
|
+
| ADR quality | An accepted ADR with no meaningful consequences | error / warn |
|
|
112
|
+
| Security | A security-sensitive feature with no documented security impact | error / warn |
|
|
113
|
+
| Drift | Memory that references a missing, or not-yet-accepted, ADR | error / warn |
|
|
114
|
+
| Content | A feature PRD still left as an unfilled template | warning |
|
|
115
|
+
|
|
116
|
+
```txt
|
|
117
|
+
Exit codes: 0 = healthy 1 = warnings only 2 = errors
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
Because it returns an exit code, Doctor drops straight into the completion loop:
|
|
121
|
+
|
|
122
|
+
```bash
|
|
123
|
+
pnpm test:run && pnpm typecheck && recall doctor
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
Use it locally via the generated pre-commit hook, or add `recall doctor` as a step in CI.
|
|
127
|
+
|
|
128
|
+
## Presets
|
|
129
|
+
|
|
130
|
+
Presets are opinion packs. They ship **proposed** guidance and proposed ADRs for a stack's real
|
|
131
|
+
decision forks — and they can never silently accept a choice for you (the schema enforces `Proposed`
|
|
132
|
+
status on every preset decision).
|
|
133
|
+
|
|
134
|
+
| Preset | Stack | Proposes (always as proposed ADRs) |
|
|
135
|
+
| ---------------- | ---------------- | ----------------------------------------------------------- |
|
|
136
|
+
| `kotlin-android` | Kotlin / Android | Compose, Coroutines + Flow, Hilt, Room, MVVM |
|
|
137
|
+
| `python-fastapi` | Python / FastAPI | FastAPI, PostgreSQL + SQLAlchemy, Pydantic, pytest, Redis |
|
|
138
|
+
| `ios-swift` | iOS / Swift | SwiftUI, async/await + Observation, SwiftData, MVVM |
|
|
139
|
+
| `nextjs` | Next.js / TS | App Router, typed data layer, Tailwind, Vitest + Playwright |
|
|
140
|
+
| `flutter` | Flutter | Platform and state-management guidance |
|
|
141
|
+
| `generic` | none | Architecture-neutral memory |
|
|
142
|
+
|
|
143
|
+
Adding a preset is a small contribution — see [CONTRIBUTING.md](CONTRIBUTING.md).
|
|
144
|
+
|
|
145
|
+
## How It Works
|
|
146
|
+
|
|
147
|
+
```txt
|
|
148
|
+
Recall OS creates and validates memory under docs/ and .recall/
|
|
149
|
+
|
|
150
|
+
intent ─┐
|
|
151
|
+
decisions ─┤ recall init / feature / adr / module ┌─ humans review
|
|
152
|
+
ownership ─┼──────────────────────────────────────────────────►│
|
|
153
|
+
standards ─┤ docs/ + .recall/config.json └─ agents re-read
|
|
154
|
+
security ─┘ │
|
|
155
|
+
▼
|
|
156
|
+
recall doctor ──► 0 / 1 / 2 ──► hook or CI gate
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
## Repository Memory
|
|
160
|
+
|
|
161
|
+
Recall OS creates a memory structure under `docs/` and `.recall/config.json`, with an explicit
|
|
162
|
+
source-of-truth order:
|
|
163
|
+
|
|
164
|
+
```txt
|
|
165
|
+
1. Accepted ADRs and repository decisions 6. Module docs
|
|
166
|
+
2. Architecture docs 7. Feature plans
|
|
167
|
+
3. Engineering standards 8. Task files
|
|
168
|
+
4. Current PRD and accepted changes 9. External context
|
|
169
|
+
5. Security and testing docs 10. Chat history
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
If external context or chat history conflicts with repository memory, **repository memory wins**.
|
|
173
|
+
|
|
174
|
+
## Local-First Guarantees
|
|
175
|
+
|
|
176
|
+
Recall OS does not:
|
|
177
|
+
|
|
178
|
+
- make network calls at runtime;
|
|
179
|
+
- collect telemetry;
|
|
180
|
+
- connect to MCP servers or call AI APIs;
|
|
181
|
+
- generate production application code;
|
|
182
|
+
- install dependencies into your repository;
|
|
183
|
+
- overwrite existing files by default.
|
|
184
|
+
|
|
185
|
+
## Examples
|
|
186
|
+
|
|
187
|
+
Committed sample outputs show the exact memory each preset generates:
|
|
188
|
+
|
|
189
|
+
```txt
|
|
190
|
+
examples/generated-generic/ examples/generated-kotlin-android/
|
|
191
|
+
examples/generated-nextjs/ examples/generated-python-fastapi/
|
|
192
|
+
examples/generated-ios-swift/ examples/generated-flutter/
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
## Development
|
|
196
|
+
|
|
197
|
+
```bash
|
|
198
|
+
pnpm install
|
|
199
|
+
pnpm lint
|
|
200
|
+
pnpm format:check
|
|
201
|
+
pnpm test:run
|
|
202
|
+
pnpm typecheck
|
|
203
|
+
pnpm build
|
|
204
|
+
pnpm pack:check
|
|
205
|
+
```
|
|
206
|
+
|
|
207
|
+
Run the gates above and `recall doctor` before claiming work is complete. See
|
|
208
|
+
[CONTRIBUTING.md](CONTRIBUTING.md) for the full workflow and how to add a preset, and
|
|
209
|
+
[SECURITY.md](SECURITY.md) for the security model.
|
|
210
|
+
|
|
211
|
+
## License
|
|
212
|
+
|
|
213
|
+
MIT — see [LICENSE](LICENSE).
|
package/dist/cli.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
#!/usr/bin/env node
|