sim-one-alpha

SIM-ONE Alpha Documentation

This directory contains the canonical product, operations, reference, and architecture documentation for SIM-ONE Alpha.

Start Here

Goal	Documentation
Check pre-release availability	Pre-Release Status
Install the product	Installation
Complete first-run setup	Onboarding
Use the terminal interface and durable sessions	Terminal And Session Guide
Configure models, credentials, storage, memory, and services	Configuration Reference
Connect Telegram, the Web API, or another connector	Connectors And Pairing
Add skills, tools, workers, or MCP servers	Extending SIM-ONE Alpha
Look up product commands	CLI Reference
Integrate with the gateway	HTTP API Reference
Understand governance and execution	Architecture Overview
Trace protocols, workers, retrieval, and workflows	Execution Workflows
Diagnose an installed system	Troubleshooting

Interactive Codebase Explorer

SIM-ONE Alpha on DeepWiki provides generated architecture diagrams, source-linked explanations, and Ask Devin for repository-grounded questions.

DeepWiki is generated from repository source and serves as an interactive exploration companion. The versioned documentation in this repository remains the authoritative product and architecture contract.

Product Guides

• Pre-Release Status separates source-available behavior from the remaining 0.1.0 Beta release gates.
• Installation covers the packaged installer, source builds, installed paths, and verification.
• Onboarding covers credentials, authorization, first chat, and connector pairing.
• Terminal And Session Guide covers the terminal layout, explicit session lifecycle, restored history, compaction, and slash commands.
• Connectors And Pairing covers trusted connector ingress, Telegram pairing and allow lists, groups, Web API access, and scheduled execution.
• Extending SIM-ONE Alpha covers built-in and runtime capability layers, sources, versions, approvals, and lifecycle.

Reference

• Configuration Reference
• CLI Reference
• HTTP API Reference

Architecture

• Architecture Index
• Architecture Overview
• Flue Architecture Contract
• Orchestrator Flow
• Protocol System
• Tool System
• Skill System
• Worker System
• Retrieval And Research
• Execution Workflows
• Capability System
• Registry System
• Memory System
• Model System
• Schedules System

Operations

• Troubleshooting
• Telegram Connector Operations
• Product TUI Operations

Framework Documentation

• SIM-ONE Framework
• Flue

The in-repository guides are versioned with the product. Framework sites explain the underlying governance and runtime models.

Documentation Boundaries

Product users should begin with the guides and references above. Detailed source maps, implementation plans, generated research snapshots, agent process instructions, and archived documents are maintained for engineering history; they are not the installed-product contract.

This site is open source. Improve this page.