bvandeusenandClaude Opus 5.5
e99f1169f7
CI & Build / Python lint (push) Successful in 3s
CI & Build / Plugin hooks (push) Successful in 12s
CI & Build / TypeScript typecheck (push) Successful in 52s
CI & Build / integration (push) Successful in 1m1s
CI & Build / Python tests (push) Successful in 1m55s
CI & Build / Build & push image (push) Successful in 36s
Step 1 of the Scribe -> Grimoire rename: every capitalised "Scribe" in prose
becomes "Grimoire" ("Fabled Scribe" -> "Fabled Grimoire") across the UI,
the PWA manifest and page title, the MCP instructions and tool docstrings,
hook and skill text, docs and README, with the tests that assert on that
prose moving with it. Old migrations keep their wording.
Identifiers are untouched here: the package, plugin name, MCP server key,
hook file names, env vars, the .scribe marker and FabledScribe repo/image
names move in steps 2 and 3, along with prose that quotes them.
The sweep matched "Scribe" only as a whole word, so describe/subscribe and
friends are untouched. The longer name took the MCP instructions one
character over their 1,600 budget; two phrases are shortened to fit.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
43 lines
2.5 KiB
Markdown
43 lines
2.5 KiB
Markdown
# Fabled Grimoire
|
|
|
|
A self-hosted work system-of-record for software projects, built to be driven by Claude Code. Notes, tasks, issues, projects, milestones, rules, and stored processes — reachable from Claude via a built-in MCP endpoint and a bundled Claude Code plugin, with a clean web UI for humans. No in-app LLM; Claude is the sole assistant.
|
|
|
|
## Features
|
|
|
|
Notes, tasks and issues; projects with milestones as plans; rules that reach Claude when its work matches them or at a moment of work; lessons, snippets of prior art and a ledger of the code they account for; design systems; ideas shared across projects on the same platform; and stored processes. Semantic search feeds both Claude's recall and the plugin's context injection. A knowledge graph, sharing with users and groups, and scheduled backups round it out. See [Features](docs/features.md).
|
|
|
|
## Quick Start
|
|
|
|
**Prerequisites:** Docker and Docker Compose. No GPU or local model needed — Claude is the sole assistant, reached over MCP.
|
|
|
|
Download [`docker-compose.quickstart.yml`](docker-compose.quickstart.yml) from this repo, then:
|
|
|
|
```bash
|
|
# Optional but recommended — set a secret key
|
|
export SECRET_KEY=your-random-secret-here
|
|
|
|
docker compose -f docker-compose.quickstart.yml up -d
|
|
```
|
|
|
|
Open `http://localhost:5000`. The first user to register becomes admin. To connect Claude, create an API key under **Settings → MCP Access** and install the Claude Code plugin — see [API Keys & MCP](docs/api-keys-and-mcp.md).
|
|
|
|
> **Development:** To build from source, see [Development](docs/development.md).
|
|
|
|
## Documentation
|
|
|
|
| Doc | Contents |
|
|
|-----|----------|
|
|
| [Architecture](docs/architecture.md) | Stack, design decisions, data models, key services |
|
|
| [Configuration](docs/configuration.md) | Environment variables, Docker Compose, production setup, security |
|
|
| [Features](docs/features.md) | Detailed feature breakdown and keyboard shortcuts |
|
|
| [Development](docs/development.md) | Dev workflow, CI/CD, migrations, release process |
|
|
| [API Keys & MCP](docs/api-keys-and-mcp.md) | API keys and installing the Claude Code plugin |
|
|
| [SSO / OAuth](docs/sso-oauth.md) | OIDC setup for Authentik, Keycloak, and other providers |
|
|
| [Backups](docs/backups.md) | Scheduled backups to a folder or S3, and restoring from one |
|
|
| [Design system](docs/design-system.md) | The FabledSword house style and how Grimoire applies it |
|
|
| [API Reference](docs/api-reference.md) | All REST API endpoints |
|
|
|
|
## License
|
|
|
|
This project is privately maintained.
|