Quick StartΒΆ
Get Perspt running in 5 minutes.
PrerequisitesΒΆ
Rust 1.82+ |
rustup.rs for building from source |
API Key |
From any provider (OpenAI, Anthropic, Google, etc.) OR Ollama for local models |
InstallationΒΆ
git clone https://github.com/eonseed/perspt.git
cd perspt
cargo build --release
cargo install perspt
# Install Ollama
brew install ollama # macOS
# Start and pull a model
ollama serve
ollama pull llama3.2
Set Your API KeyΒΆ
# Choose your provider
export OPENAI_API_KEY="sk-..." # OpenAI
export ANTHROPIC_API_KEY="sk-ant-..." # Anthropic
export GEMINI_API_KEY="..." # Google
Run Your First ChatΒΆ
# Start the TUI
./target/release/perspt
# Or with a specific model
perspt chat --model gpt-5.2
Type your message and press Enter. Press Esc to exit.
Try Agent ModeΒΆ
Added in version 0.5.0.
Let Perspt autonomously write code:
# Basic task
perspt agent "Create a Python calculator with add, subtract, multiply, divide"
# With workspace directory
perspt agent -w ./my-project "Add unit tests for the API"
# Auto-approve all changes
perspt agent -y "Refactor the parser for better error handling"
The SRBN engine will:
Sheafify β Decompose task into sub-tasks
Speculate β Generate code for each sub-task
Verify β Check with LSP and tests
Converge β Retry until V(x) < Ξ΅
Commit β Record in Merkle ledger
See also
Agent Mode Tutorial for a full walkthrough.
Choose Your ModeΒΆ
Mode |
Command |
Best For |
|---|---|---|
Chat TUI |
|
Interactive conversations with markdown rendering |
Agent |
|
Autonomous code generation and modification |
Status |
|
Check current agent session status |
Essential CommandsΒΆ
# Configuration
perspt config --show # View current config
perspt config --edit # Edit in $EDITOR
perspt init --memory --rules # Initialize project
# Agent management
perspt status # Current session status
perspt abort # Cancel current session
perspt resume # Resume interrupted session
# Change tracking
perspt ledger --recent # View recent changes
perspt ledger --rollback abc # Rollback to commit
Key Bindings (Chat TUI)ΒΆ
Key |
Action |
|---|---|
Enter |
Send message |
Esc |
Exit application |
β/β |
Scroll chat history |
Page Up/Down |
Fast scroll |
/save |
Save conversation (command) |
Next StepsΒΆ
Step-by-step learning guides.
Customize providers and models.
Master autonomous coding.
Understand the 7-crate design.