An open API service indexing awesome lists of open source software.

https://github.com/adrozdenko/soleri

An open-source framework for building AI assistants that learn, remember, and grow with you.
https://github.com/adrozdenko/soleri

ai ai-assistants brain claude-code framework knowledge mcp memory open-source personas typescript vault

Last synced: about 17 hours ago
JSON representation

An open-source framework for building AI assistants that learn, remember, and grow with you.

Awesome Lists containing this project

README

          


S O L E R I


CI
npm version
License
Downloads
Node version

---

Every AI session starts from zero. You explain your conventions, your architecture, your preferences — and then the session ends and it's all gone. You do it again tomorrow. And the day after that.

**Your expertise should compound — not evaporate.**

Soleri is an open-source second brain builder. It gives your AI assistant persistent memory, structured knowledge, and intelligence that grows with every session.

## How It Works

Your second brain is a **folder**. No TypeScript, no build step, no `npm install`.

```
my-brain/
├── agent.yaml # what do I know
├── instructions/ # how I think
├── workflows/ # how I work
├── knowledge/ # what I've learned
└── .mcp.json # connects to Soleri Knowledge Engine
```

your AI editor reads the folder natively. The **Knowledge Engine** provides the infrastructure — a vault that remembers, a brain that learns what works, and memory that carries across every project and conversation. The more you use it, the smarter it gets.

## What You Get

**Platform:** macOS, Linux, and Windows (via Git Bash). See the [Windows setup guide](https://soleri.ai/docs/guides/windows/) for details.

**Prerequisites:**
- [Node.js 18+](https://nodejs.org) (npm ships with it)
- An MCP-compatible AI editor: [Claude Code](https://docs.anthropic.com/en/docs/claude-code), [Codex](https://github.com/openai/codex), or [OpenCode](https://github.com/opencode-ai/opencode)

```bash
npx --yes soleri create my-brain # Build your second brain (~3 seconds)
npx --yes soleri install # Connect to your editor
npx --yes soleri dev # Start learning
npx --yes soleri doctor # Check system health
```

> **npx vs global install:** The commands above use `npx --yes` which downloads and runs the CLI without a global install. The `--yes` flag skips the confirmation prompt. If you prefer a persistent install, run `npm install -g soleri` and then use bare `soleri` commands (e.g. `soleri create my-brain`).

Your second brain is ready the moment it's created. No build step needed.

### Persona System

Every agent has a composable persona that defines HOW it communicates — voice, traits, quirks, opinions, and cultural texture. New agents ship with the Italian Craftsperson persona (inspired by Paolo Soleri): warm, opinionated about quality, universal across domains. Define your own in `agent.yaml` under the `persona:` block.

### The Engine

**Vault** — Domain-separated knowledge store. Patterns, anti-patterns, workflows, and architecture decisions organized by domain, graph-connected for cross-domain discovery. Self-maintaining: deduplication, decay detection, and confidence tracking happen automatically. Knowledge packs export and import with Zettelkasten links — new agents inherit the full knowledge graph, not just orphaned entries.

**Brain** — Learning loop that captures intelligence from real sessions. Search combines SQLite FTS5 with TF-IDF scoring. Tracks pattern strength with confidence scores, surfaces high-confidence patterns first, and operates on a rolling window. No manual tagging — capture is automatic.

**Memory** — Cross-session, cross-project continuity. Switch conversations, switch projects — nothing is lost. Link projects as related, parent/child, or fork and search across all of them with weighted relevance.

**Playbooks** — Multi-step validated procedures stored in the vault. Token migrations, component setup, contrast audits — each step includes validation criteria so the agent can execute and verify autonomously.

### Second Brain (v8.0)

The engine now acts as a true second brain — it doesn't just store knowledge, it actively helps you use it:

- **Two-pass search** — Scan titles first, load only what's relevant. Saves 60-80% context tokens.
- **Session briefing** — Start every session with context: what you did last time, active plans, recent learnings, brain recommendations.
- **Learning radar** — Automatically detects patterns from corrections, search misses, and workarounds. Captures silently or queues for review.
- **Content synthesis** — Turn vault knowledge into briefs, outlines, talking points, or post drafts.
- **Skill chains** — Multi-step workflows with data flow between steps and approval gates.
- **External ingestion** — Ingest articles, transcripts, and notes from outside coding sessions.
- **Evidence-based reconciliation** — Cross-references plan tasks against actual git changes.
- **OAuth discovery** — Uses your Claude Code subscription for free Anthropic API access (macOS + Linux).

### Architecture

Two layers, cleanly separated:

```
┌─────────────────────────────────────────────────────────┐
│ Agent Folder agent.yaml · instructions/ · workflows/ │
│ (the shell) knowledge/ · skills/ · CLAUDE.md (auto) │
├─────────────────────────────────────────────────────────┤
│ Knowledge Engine 20 modules: vault · brain · curator · planner │
│ (the brain) memory · archive · sync · review · links … │
├─────────────────────────────────────────────────────────┤
│ Transports MCP · HTTP/SSE · WebSocket · Telegram │
└─────────────────────────────────────────────────────────┘
```

- **Agent Folder** — Plain files (YAML, Markdown, JSON). your AI editor reads them natively. No code generation, no compilation.
- **Knowledge Engine (`@soleri/core`)** — Persistent state for all agents. Vault (SQLite + FTS5), Brain (hybrid TF-IDF + optional Cognee vector search), Planner (state machine), Curator (dedup, grooming), and cross-project memory.
- **Extensions** — Two tiers: **Domain Packs** (npm packages like `@soleri/domain-design`) for published intelligence, and **Local Packs** (project directories with `soleri-pack.json`) for project-specific knowledge, skills, and hooks. All extensions receive a narrowed `PackRuntime` (vault + projects + session checks).
- **Model-agnostic** — The engine runs on pure SQLite FTS5 and TF-IDF math. Works without API keys. Pure SQLite — no external services required.

### Persistence

Soleri uses **SQLite** (via [better-sqlite3](https://github.com/WiseLibs/better-sqlite3)) as its sole storage engine. This is a deliberate architectural choice:

- **FTS5** for full-text search with BM25 ranking — no external search service needed
- **WAL mode** for concurrent reads during writes
- **Zero ops** — no database server to provision, no connection strings to manage
- **Tested at scale** — 10K vault entries with sub-50ms FTS search (see `vault-scaling.test.ts`)

The `PersistenceProvider` interface exists for future extensibility, but SQLite is the only implemented and tested backend.

### Packages

| Package | Description |
| ----------------------------------------- | ------------------------------------------------------------------------------------ |
| [`@soleri/core`](packages/core) | Knowledge Engine — vault, brain, planner, curator, `registerEngine()`, engine binary |
| [`@soleri/forge`](packages/forge) | Agent scaffolder — generates file-tree agents from config |
| [`@soleri/cli`](packages/cli) | Developer CLI — create, install, dev, doctor, packs, hooks |
| [`create-soleri`](packages/create-soleri) | `npm create soleri` shorthand |
| [`@soleri/domain-*`](packages/) | Domain packs — design, component, figma, code-review |

### Guides

- [**Knowledge Management**](docs/guides/knowledge-management.md) — How to feed, train, and curate your agent's brain. The daily rhythm: search, capture, curate.

### Knowledge Packs

Install expertise in one command:

| Tier | Source | Cost |
| ------------- | ---------------- | ---- |
| **Starter** | Ships with agent | Free |
| **Community** | npm registry | Free |

```bash
npx --yes soleri install-knowledge ./bundles/react-patterns
```

### Hook Packs

Automated quality gates and safety guardrails for Claude Code:

```bash
npx --yes soleri hooks add-pack safety # Anti-deletion staging for destructive commands
npx --yes soleri hooks add-pack flock-guard # Parallel agent lockfile protection
npx --yes soleri hooks add-pack clean-commits # No AI attribution in git commits
npx --yes soleri hooks add-pack typescript-safety # Block unsafe TS patterns
npx --yes soleri hooks add-pack a11y # Accessibility enforcement
npx --yes soleri hooks add-pack full # All of the above
```

Convert your own skills into automated hooks:

```bash
npx --yes soleri hooks convert my-hook --event PreToolUse --matcher "Write|Edit" \
--pattern "**/src/**" --action remind --message "Check guidelines"
npx --yes soleri hooks test my-hook # Validate with fixtures
npx --yes soleri hooks promote my-hook # remind → warn → block
```

### Teams & Ops

- **Connected vaults** — Link agent, project, and team vaults with automatic search priority.
- **Cross-project knowledge** — Link projects and search across them with weighted relevance.
- **Health checks** — `npx --yes soleri doctor` reports engine version, domain status, vault health, brain tracking, and team sync state.

## Testing

```bash
npm test # Unit tests — 313 files, 3,900+ tests
npm run test:e2e # E2E tests — 900+ tests across 30 files
```

The E2E suite covers: file-tree agent full pipeline (scaffold → engine boot → MCP → ops), all 20 engine modules across 8 vault-family facades, over-the-wire MCP transport, data persistence, concurrency, CLI commands, hook pack validation, and domain pack validation.

## Contributing

From fixing typos to building domain modules — see [CONTRIBUTING.md](CONTRIBUTING.md).

## Roadmap

[GitHub Milestones](https://github.com/adrozdenko/soleri/milestones)

## License

[Apache 2.0](LICENSE)

---


Named after Paolo Soleri, the architect who believed structures should be alive, adaptive, and evolving.


soleri.ai · npm · Issues · Discussions