README
¶
Solomon documentation
Welcome to the in-repo wiki for Solomon. Articles are grouped by topic into portals (folders). Each portal has an index page; articles end with a See also section for cross-links.
Documentation map
| If you want to… | Start here |
|---|---|
| Install Solomon | Installation and PATH |
| First run and REPL basics | Usage and commands — Quickstart |
| Configure providers, MCP, web search | Configuration |
| REPL, slash commands, CLI modes | Usage and commands |
| Find chats, plans, skills, exports on disk | Data layout |
| Automate in CI | Machine output · GitHub Actions example |
| Compare capabilities | Feature catalog |
| What Solomon is and design tenets | Overview |
| Contribute or debug internals | Package index · Agent turn pipeline · Tests |
Development: Testing, Cookbook · Startup flow: Startup and CLI
Portals
| Portal | Index | Topics |
|---|---|---|
| Using Solomon | user-guide/README.md | Configuration, CLI modes, terminal fonts/colors, on-disk layout |
| Internals & design | architecture/README.md | Packages, functions, runtime flows, tools, MCP |
| Building & releasing | development/README.md | go vet / test / build, release workflow |
Suggested reading paths
New user
- Installation and PATH
- Usage and commands — Quickstart
- Installation and PATH — PATH setup — if
solomonis not on PATH aftergo install - Configuration
- Usage and commands
- Terminal setup — monospace font and colors
- Data layout
Backends without native tool calling
Contributor or debugger
- Package index — every
internal/andcmd/package - Overview — design tenets and dependency graph
- Startup and CLI
- Agent turn pipeline
- Runtime hub — debug playbook
- Runtime — REPL input or orchestration as needed
- Cursor integration — if using or debugging Cursor API provider
- Supporting packages — auth, tooloutput, updater, instructions
- Continue through the architecture portal in listed order
- Testing and Cookbook before landing changes
CI / automation
Maintainer
Glossary
| Term | Meaning |
|---|---|
| Runtime | internal/agent/runtime.Runtime — REPL, turns, persistence, MCP wiring |
| Session | chatstore.Session — messages, checkpoints, images, persisted as JSON under ~/.solomon/projects/<id>/chats/ |
| Project id | 64-char hex from canonical workspace root (project.Resolve) |
| Plan / build mode | Runtime.Mode — restricts native tools and system prompt (plan vs build) |
| Legacy tools | Optional [tools].legacy / legacy_force in config — text <tool_calls> XML when native function calling is missing or unreliable |
| Slash command | REPL line starting with / — handled by agent.SlashDispatch → slash.Dispatch → commands package |
| APIContent | Optional chatstore.Message field: visible transcript text vs payload sent to the LLM (e.g. @ expansion, forced /skill:) |
| Cursor sidecar | Local Node OpenAI proxy for Cursor API provider — Cursor integration |
Featured articles
- Feature catalog — capabilities ranked by cross-agent fame, plus Solomon-only and distinctive features
- Configuration —
config.toml, web search, logs, legacy XML tools - Terminal setup — monospace font, ligatures, ANSI colors
- Package index — canonical package map with tiers
- Overview — design tenets and dependency graph
- Agent turn pipeline — LLM stream, tool loop, legacy XML
See also
- Overview — what Solomon is, early-release status, design tenets
- Installation and PATH
- Usage and commands — Quickstart
Documentation
¶
Source Files
Click to show internal directories.
Click to hide internal directories.