spikuit 0.5.5

A knowledge base that gets smarter the more you use it

Spikuit

English | 日本語

A knowledge base that gets smarter the more you use it.

Documentation: https://takyone.github.io/spikuit/

Source Code: https://github.com/takyone/spikuit

⚠️ Pre-1.0 / under active development. Spikuit is moving fast toward v1.0.0 (Daily Use Ready). Expect frequent breaking changes to the CLI, data schema, and Python API until then. Pin exact versions and read the release notes before upgrading.

---

What is Spikuit?

Spikuit (spike + circuit, pronounced /spaɪ.kɪt/) is a personal knowledge system built around one idea: your knowledge base should learn from you, not just store things.

Every time you search, review, or ask a question, Spikuit quietly adapts — boosting what's useful, connecting related ideas, and surfacing what you're about to forget.

It works as:

• A self-improving knowledge base — search quality gets better through usage, not re-indexing
• A study partner — an AI tutor that teaches, quizzes, and coaches based on what you actually know
• An agent's brain — a knowledge graph that AI agents can read, write, and learn from

What makes it different?

	Anki	Obsidian + SRS	Spikuit
Scheduling	Per-card	Per-note	Per-concept, connected
Knowledge structure	Flat deck	Manual links	Auto-growing graph
Search	Keyword	Keyword + tags	Semantic + graph-weighted
Retrieval quality	Static	Static	Improves with usage
AI integration	Limited	Plugins	Built-in (agent-native)

Spikuit doesn't replace these tools — it explores what becomes possible when you combine a knowledge graph, spaced repetition, and AI agents into one system.

Quick Start

1. Install

pip install spikuit

2. Create a Brain

A "Brain" is Spikuit's workspace — like a .git/ directory for your knowledge. Run spkt init where you want to set one up:

mkdir my-brain && cd my-brain
spkt init

The interactive wizard will ask about embedding settings. If you're just trying things out, choose "none" for embeddings — you can configure them later.

3. Add some knowledge

# Add a concept
spkt neuron add "# Ownership in Rust\n\nEach value has exactly one owner. When the owner goes out of scope, the value is dropped." \
  -t concept -d rust

# Add from a URL
spkt source learn "https://doc.rust-lang.org/book/ch04-01-what-is-ownership.html" -d rust

# Connect related concepts
spkt synapse add <id-1> <id-2> -t relates_to

4. Set up Agent CLI skills (recommended)

Spikuit's interactive skills — tutoring, knowledge curation, and Q&A — run inside Agent CLIs like Claude Code, Cursor, or Codex. To use them, install the skill definitions:

spkt skills install                    # defaults to .claude/skills/
spkt skills install -t .cursor/skills  # or specify your agent

This copies the skill files (SKILL.md) and an agent context file (SPIKUIT.md) that gives the agent a complete command reference.

5. Start using it

From your Agent CLI:

You: /spkt-teach
     I'm studying category theory. A Functor maps between categories
     preserving structure. A Monad is a monoid in the category of endofunctors.

Agent: Added 2 neurons, 1 synapse (Monad --requires--> Functor).

You: /spkt-qabot
     What's the relationship between Functors and Monads?

Agent: A Monad is built on top of a Functor...
       Sources: n-abc123 (Functor), n-def456 (Monad)

You: /spkt-tutor

Tutor: Let's start with Functor — it's a prerequisite for Monad.
       [teaches, quizzes, gives feedback]

You: /spkt-curator

Curator: Your "math" domain spans 2 communities (algebra vs. analysis).
         Split into sub-domains? [Y/n]

Or use spkt commands directly:

spkt retrieve "ownership borrow"           # search your knowledge graph
spkt neuron due                            # what needs reviewing?
spkt neuron fire <id> -g fire              # record a review
spkt diagnose                              # brain health check
spkt consolidate                           # optimize graph structure
spkt visualize                             # interactive HTML graph

All commands support --json for machine-readable output.

Use Cases

/spkt-teach + /spkt-qabot : Self-improving RAG

Feed sources into your brain, then query it. Retrieval quality improves with every conversation — no re-indexing needed.

You: /spkt-teach
     Here's an article on attention mechanisms: https://arxiv.org/abs/1706.03762

Agent: Added 8 neurons (Multi-Head Attention, Scaled Dot-Product, ...).
       6 synapses created, source linked for citation.

You: /spkt-qabot
     How does multi-head attention differ from single-head?

Agent: Multi-head attention runs multiple attention functions in parallel,
       each with different learned projections...

       Sources:
       - [Attention Is All You Need](https://arxiv.org/abs/1706.03762) (via n-a1b2c3)

You: What about computational cost?

Agent: [prior results auto-penalized, new neurons retrieved]

/spkt-teach + /spkt-tutor : AI study partner

Build a knowledge graph from your study material, then let an AI tutor teach, quiz, and coach you based on what you actually know.

You: /spkt-teach
     I'm studying category theory. Key concepts:
     - A Functor maps between categories preserving structure
     - A Natural Transformation is a morphism between functors
     - A Monad is a monoid in the category of endofunctors

Agent: Added 3 neurons, 2 synapses (Monad/NatTrans --requires--> Functor).

You: /spkt-tutor

Tutor: You have 3 new concepts. Let's start with Functor —
       it's a prerequisite for the other two.
       [teaches, then quizzes]

You: It's like... a mapping that keeps the structure?

Tutor: Right direction, but incomplete. A functor maps both objects
       AND morphisms, and must preserve composition and identity.
       Can you give an example of a functor between two concrete categories?

How It Works

Spikuit organizes knowledge as a graph — concepts are nodes, relationships are edges. When you interact with the graph, three things happen automatically:

1. Smart scheduling — each concept has its own review timing based on how well you know it (powered by FSRS)
2. Activation spreading — reviewing one concept nudges related concepts closer to their review time. Connections that are used together get stronger.
3. Search optimization — results are ranked by relevance × how well you know each concept × how central it is in your graph. Feedback from conversations continuously improves ranking.

For the technical details behind these mechanisms, see Appendix: Algorithms.

Documentation

• Getting Started — install, init, first commands
• How to Use — use cases, agent skills, Python API
• Concepts — brain, graph model, how things connect
• CLI Reference — all spkt commands
• Appendix: Algorithms — FSRS, graph propagation, technical details
• API Reference — Python API docs

Architecture

spikuit-core/     # Pure engine (no LLM dependency)
spikuit-cli/      # spkt command
spikuit-agents/   # Agent skills and adapters

The core engine is LLM-independent — spkt commands work standalone. Agent skills (/spkt-tutor, /spkt-teach, /spkt-qabot, /spkt-curator) add LLM-powered interactions on top, designed for Agent CLIs like Claude Code.

Development

git clone https://github.com/takyone/spikuit.git
cd spikuit
uv sync --package spikuit-core --extra dev
uv run --package spikuit-core pytest spikuit-core/tests/ -v

License

Apache-2.0