bvandeusen
ab9b5b647c
Milestone #194 plugin/docs slice. - plugin.json: "second brain" framing -> "system-of-record"; bump 0.1.11 -> 0.1.12 (any plugin/ change must bump the manifest, issue #1040) - plugin/README.md + using-scribe SKILL + scribe_static_context: drop events/typed-entities from the surface lists; "second brain" -> "system of record" in the SessionStart context Claude reads each session - docs/api-keys-and-mcp.md: drop the Typed-entities + Events MCP tool rows, add the Systems row - README.md: rewrite the stale front-matter (chat/RAG/calendar/weather/push described a pre-pivot product) to the current Claude-driven work store Deeper pre-pivot doc-rot in docs/features.md + docs/api-reference.md (chat/journal/weather/web-research) is tracked separately as an issue. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01BPtbSzA4JLMAKgFZ8VTg7Q
43 lines
2.2 KiB
Markdown
43 lines
2.2 KiB
Markdown
# Fabled Scribe
|
|
|
|
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 and tasks with a Markdown editor, sub-tasks, milestones, issues, and kanban project workspaces. Stored processes, an engineering rulebook system, and semantic search with proactive knowledge-injection into Claude's context. A knowledge graph, per-user/group sharing, and a built-in MCP server (`/mcp`) plus a bundled Claude Code plugin so Claude can record and recall your work directly.
|
|
|
|
## Quick Start
|
|
|
|
**Prerequisites:** Docker and Docker Compose. 8 GB+ RAM recommended for LLM inference.
|
|
|
|
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. Go to **Settings → General** to pull an LLM model — `qwen3:8b` or `llama3.1:8b` are good starting points.
|
|
|
|
> **GPU:** Ollama runs CPU-only by default. See the comments in `docker-compose.quickstart.yml` to enable NVIDIA GPU passthrough.
|
|
|
|
> **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 key management and Fable MCP install guide |
|
|
| [SSO / OAuth](docs/sso-oauth.md) | OIDC setup for Authentik, Keycloak, and other providers |
|
|
| [API Reference](docs/api-reference.md) | All REST API endpoints |
|
|
|
|
## License
|
|
|
|
This project is privately maintained.
|