README
¶
Studious
A local documentation server that gives AI coding assistants persistent, searchable access to your knowledge base.
Studious scans directories on your machine for markdown files, builds a search index, and exposes that knowledge through the Model Context Protocol (MCP) - the open standard that tools like Cursor, Claude Desktop, Windsurf, and others use to connect AI models to external data sources.
Quick start
# Install
brew install Drew-Daniels/tap/studious
# Create config and add your docs
studious config
# Start the server (Cursor/Claude connect via stdio)
studious
# Or try a search from the command line
studious search "deployment rollback procedure"
Why Studious?
You already have documentation scattered across your machine - project notes, research, wikis, runbooks, ADRs, glossaries. But your AI assistant doesn't know where any of it lives. You end up re-explaining your project setup, re-pasting context, and re-defining jargon at the start of every session.
Studious gives your AI persistent, instant context. Index your docs once, and every future conversation starts with full knowledge of your projects, your terminology, and your way of doing things.
- Zero-config start. Point it at a directory, and it works. No database, no cloud service, no API keys.
- Everything stays local. Your documentation never leaves your machine.
- Multi-source. Index personal notes, project docs, a cloned team wiki, and ADRs - all at once.
- Rich search. Synonym expansion, fuzzy matching, phrase boosting, tag filtering, date ranges, and optional semantic search.
- Single static binary. No runtime dependencies. Download it, run it.
Development
# Install all tools and git hooks
just setup
# Run fmt + lint + test
just check
# Build binary
just build
See CONTRIBUTING.md for details.
License
Directories
¶
| Path | Synopsis |
|---|---|
|
studious
command
|
|
|
internal
|
|
|
cache
Package cache persists and restores the documentation index to avoid full rebuilds.
|
Package cache persists and restores the documentation index to avoid full rebuilds. |
|
cli
Package cli provides configuration loading, output formatting, and terminal utilities for studious commands.
|
Package cli provides configuration loading, output formatting, and terminal utilities for studious commands. |
|
config/gen
command
|
|
|
index
Package index builds and maintains the documentation search index.
|
Package index builds and maintains the documentation search index. |
|
search
Package search provides full-text search, synonym expansion, and ranking over a DocIndex.
|
Package search provides full-text search, synonym expansion, and ranking over a DocIndex. |
|
server
Package server implements the MCP server that exposes documentation tools to AI assistants.
|
Package server implements the MCP server that exposes documentation tools to AI assistants. |
|
text
Package text provides tokenization, stemming, and text analysis utilities.
|
Package text provides tokenization, stemming, and text analysis utilities. |