Documentation Index Fetch the complete documentation index at: https://mintlify.com/nyldn/claude-octopus/llms.txt
Use this file to discover all available pages before exploring further.
Advanced configuration
Claude Octopus provides extensive configuration options for tailoring workflows, controlling costs, and extending functionality.
Environment variables
Environment variables control provider behavior, timeouts, and feature flags.
Provider configuration
Authentication
Provider control
Model selection
Timeouts
# API key authentication (per-token billing)
export OPENAI_API_KEY = "sk-..." # Codex API key
export GEMINI_API_KEY = "..." # Gemini API key
export GOOGLE_API_KEY = "..." # Alternative to GEMINI_API_KEY
export PERPLEXITY_API_KEY = "..." # Perplexity Sonar API key
Workflow configuration
Autonomy modes
Quality gates
Session management
# Default autonomy for embrace workflows
export OCTOPUS_AUTONOMY = "supervised" # supervised, semi-autonomous, autonomous
# Auto-proceed on quality gate pass
export OCTOPUS_AUTO_PROCEED = true # Skip approval if gates pass
# Consensus threshold (default: 0.75)
export OCTOPUS_CONSENSUS_THRESHOLD = 0.80 # Require 80% consensus
Feature flags
Claude Code features
Octopus features
# Feature detection (read-only, set by Claude Code)
export SUPPORTS_PERSISTENT_MEMORY = true # v2.1.33+ persistent memory
export SUPPORTS_FAST_OPUS = true # v2.1.36+ fast Opus mode
export SUPPORTS_WORKTREE = true # v2.1.26+ git worktree isolation
Setting environment variables permanently
Add to your shell profile:
# ~/.bashrc or ~/.zshrc
# Provider authentication
export OPENAI_API_KEY = "sk-..."
export GEMINI_API_KEY = "..."
# Octopus preferences
export OCTOPUS_AUTONOMY = "semi-autonomous"
export OCTOPUS_CONSENSUS_THRESHOLD = 0.80
export OCTOPUS_OPUS_MODE = "standard"
# Reload
source ~/.bashrc # or source ~/.zshrc
Settings and preferences
Claude Octopus stores settings in .claude/settings.json (project-level) and uses Claude Code’s auto memory for persistent preferences.
Project settings (.claude/settings.json)
{
"enabledPlugins" : {
"claude-octopus@nyldn-plugins" : true
},
"octopus" : {
"autonomy" : "semi-autonomous" ,
"consensusThreshold" : 0.75 ,
"providers" : {
"codex" : {
"enabled" : true ,
"model" : "gpt-5.3-codex"
},
"gemini" : {
"enabled" : true ,
"model" : "gemini-pro"
}
},
"costLimit" : 5.0 ,
"qualityGates" : {
"strict" : false ,
"skipSecurity" : false ,
"skipPerformance" : false
}
}
}
Auto memory integration (Claude Code v2.1.32+)
Claude Code’s auto memory (~/.claude/projects/.../memory/MEMORY.md) persists across conversations.
Octopus records:
Preferred autonomy mode
Provider availability (which CLIs installed)
Frequently used commands
Past project contexts (tech stack, conventions)
Model preferences (Opus for premium tasks)
Example memory:
# Claude Octopus Preferences
## User Preferences
- Autonomy mode: semi-autonomous
- Consensus threshold: 80%
- Preferred model: Opus for architecture decisions
## Provider Setup
- Codex CLI: installed, OAuth authenticated
- Gemini CLI: installed, API key configured
## Frequent Workflows
- Uses /octo:quick for simple tasks
- Prefers /octo:embrace for features
- Always runs security audits before shipping
## Project Context
- Tech stack: TypeScript, React, PostgreSQL
- Coding conventions: ESLint, Prettier, strict mode
- Deployment: AWS ECS with GitHub Actions
This enables faster workflow startup by skipping provider detection and preference questions.
Configuration commands
# View current configuration
/octo:doctor config
# Set autonomy mode
/octo:model-config --autonomy semi-autonomous
# Set consensus threshold
/octo:model-config --consensus 0.80
# Configure providers
/octo:model-config --codex-model gpt-5.3-codex
/octo:model-config --gemini-model gemini-pro
Autonomy modes
Configure how much human oversight workflows require.
Supervised
Semi-autonomous
Autonomous
Default mode — maximum control and oversightBehavior:
Approval required after each phase
Review synthesis before proceeding
Best for critical features or learning
Set mode: export OCTOPUS_AUTONOMY = "supervised"
# or
/octo:embrace build auth --autonomy supervised
Use when:
High-stakes features
Learning the methodology
Requirements may change
Maximum transparency needed
Recommended mode — balanced approachBehavior:
Auto-proceeds if quality gates pass
Approval only when gates fail
Intervenes on security/performance issues
Set mode: export OCTOPUS_AUTONOMY = "semi-autonomous"
# or
/octo:embrace build auth --autonomy semi-autonomous
Use when:
Most use cases
Trusted workflows
Want efficiency with safety nets
Fully automated — no interruptionsBehavior:
Runs all phases automatically
No approval required
Review output, not every step
Set mode: export OCTOPUS_AUTONOMY = "autonomous"
# or
/octo:embrace build auth --autonomy autonomous
Use when:
Low-risk tasks
Well-specified features
Factory mode (spec-to-software)
Background processing
Autonomous mode bypasses all approvals. Review quality gates carefully in results.
Auto-proceed on quality gate pass
Combine with supervised mode to skip approvals when gates pass:
export OCTOPUS_AUTONOMY = "supervised"
export OCTOPUS_AUTO_PROCEED = true
/octo:embrace build auth
# Proceeds automatically if quality gates pass
# Pauses only if consensus < 75% or security issues found
Custom hooks and extensions
Claude Octopus supports custom hooks for extending workflows.
Hook types
Hook When it runs Use case pre-discoverBefore discover phase Custom research sources post-discoverAfter discover phase Export synthesis to docs pre-defineBefore define phase Load external requirements post-defineAfter define phase Update project specs pre-developBefore develop phase Run linters, formatters post-developAfter develop phase Run tests, deploy to staging pre-deliverBefore deliver phase Pre-flight checks post-deliverAfter deliver phase Create PR, notify team quality-gate-failedWhen quality gate fails Custom notifications
Creating hooks
Hooks are shell scripts in .claude/hooks/:
Write hook script
Create .claude/hooks/post-develop.sh: #!/bin/bash
# Post-develop hook: run tests and deploy to staging
set -e
echo "Running tests..."
npm test
echo "Deploying to staging..."
./scripts/deploy-staging.sh
echo "Notifying team..."
curl -X POST " $SLACK_WEBHOOK " \
-H "Content-Type: application/json" \
-d '{"text": "New feature deployed to staging"}'
Make executable
chmod +x .claude/hooks/post-develop.sh
Test hook
/octo:develop build feature
# Hook runs automatically after develop phase completes
Hook configuration
Configure hooks in .claude/hooks.json:
{
"hooks" : {
"post-develop" : {
"enabled" : true ,
"script" : ".claude/hooks/post-develop.sh" ,
"timeout" : 300 ,
"failOnError" : true
},
"quality-gate-failed" : {
"enabled" : true ,
"script" : ".claude/hooks/notify-failure.sh" ,
"timeout" : 30 ,
"failOnError" : false
}
}
}
Hook environment
Hooks receive context via environment variables:
# Available in all hooks
OCTOPUS_PHASE = "develop" # Current phase
OCTOPUS_WORKFLOW = "embrace" # Current workflow
CLAUDE_SESSION_ID = "abc123" # Session ID
OCTOPUS_RESULTS_DIR = "~/.claude-octopus/results/"
# Phase-specific
OCTOPUS_SYNTHESIS_FILE = "probe-synthesis-timestamp.md"
OCTOPUS_CONSENSUS_SCORE = "0.82" # Consensus percentage
OCTOPUS_QUALITY_GATE_STATUS = "pass" # pass/fail
Example hooks
Export synthesis to Notion
#!/bin/bash
# .claude/hooks/post-discover.sh
synthesis = " $OCTOPUS_RESULTS_DIR / $OCTOPUS_SYNTHESIS_FILE "
curl -X POST "https://api.notion.com/v1/pages" \
-H "Authorization: Bearer $NOTION_API_KEY " \
-H "Content-Type: application/json" \
-d @- << EOF
{
"parent": {"database_id": " $NOTION_DATABASE_ID "},
"properties": {
"Title": {"title": [{"text": {"content": "Research: $OCTOPUS_WORKFLOW "}}]}
},
"children": [
{"type": "code", "code": {"language": "markdown", "rich_text": [{"text": {"content": "$( cat $synthesis )"}}]}}
]
}
EOF
Notify Slack on quality gate failure
#!/bin/bash
# .claude/hooks/quality-gate-failed.sh
curl -X POST " $SLACK_WEBHOOK " \
-H "Content-Type: application/json" \
-d @- << EOF
{
"text": "Quality gate failed in $OCTOPUS_PHASE phase",
"attachments": [{
"color": "danger",
"fields": [
{"title": "Phase", "value": " $OCTOPUS_PHASE ", "short": true},
{"title": "Consensus", "value": " $OCTOPUS_CONSENSUS_SCORE ", "short": true},
{"title": "Session", "value": " $CLAUDE_SESSION_ID ", "short": false}
]
}]
}
EOF
Run linters before develop
#!/bin/bash
# .claude/hooks/pre-develop.sh
echo "Running ESLint..."
npm run lint
echo "Running Prettier..."
npm run format:check
echo "Running TypeScript compiler..."
npm run typecheck
echo "Pre-develop checks passed ✓"
#!/bin/bash
# .claude/hooks/post-deliver.sh
branch = "feature/ $OCTOPUS_WORKFLOW -$( date +%Y%m%d)"
git checkout -b " $branch "
git add .
git commit -m " $OCTOPUS_WORKFLOW : completed via Claude Octopus"
git push origin " $branch "
gh pr create \
--title " $OCTOPUS_WORKFLOW " \
--body "$( cat $OCTOPUS_RESULTS_DIR /delivery- * .md)" \
--base main
Configuration best practices
Use OAuth for external providers
OAuth avoids per-token billing and uses your existing subscriptions: Skip API keys unless you don’t have subscriptions.
Set autonomy mode per project
Different projects need different oversight levels: // Critical production service
{ "octopus" : { "autonomy" : "supervised" }}
// Internal tools
{ "octopus" : { "autonomy" : "autonomous" }}
Use strict quality gates for security-critical features
Never skip security gates for auth, payments, or data handling: export OCTOPUS_STRICT_GATES = true
export OCTOPUS_SKIP_SECURITY_GATE = false
Set cost limits to avoid surprises
Prevent runaway costs with limits: export OCTOPUS_COST_LIMIT = 5.00
# Workflows stop if cost exceeds $5.00
Use hooks for team integration
Automate notifications, PR creation, and deployments:
post-develop: Deploy to staging
post-deliver: Create PR
quality-gate-failed: Notify team
Diagnostics and troubleshooting
Run diagnostics
# Full diagnostics (9 check categories)
/octo:doctor
# Specific category
/octo:doctor providers # Provider installation
/octo:doctor auth # Authentication status
/octo:doctor config # Configuration
/octo:doctor hooks # Hook scripts
# Verbose output
/octo:doctor --verbose
# JSON output (for CI)
/octo:doctor --json
Common issues
Symptom: /octo:setup shows provider as “Not installed”Fix: # Check if CLI is in PATH
which codex
which gemini
# Install if missing
brew install codex-cli gemini-cli
# Verify installation
codex --version
gemini --version
Symptom: “401 Unauthorized” errorsFix: # Re-authenticate (OAuth)
codex login
gemini auth
# Verify API keys
echo $OPENAI_API_KEY
echo $GEMINI_API_KEY
# Check auth status
/octo:doctor auth --verbose
Quality gate always fails
Symptom: Consensus never reaches thresholdFix: # Lower threshold temporarily
export OCTOPUS_CONSENSUS_THRESHOLD = 0.70
# Or disable strict mode
export OCTOPUS_STRICT_GATES = false
# Review synthesis files
cat ~/.claude-octopus/results/grasp-consensus- * .md
Symptom: Hook script doesn’t executeFix: # Check hook is executable
chmod +x .claude/hooks/post-develop.sh
# Verify hook configuration
cat .claude/hooks.json
# Validate hooks
/octo:doctor hooks --verbose
# Test hook manually
./.claude/hooks/post-develop.sh
Next steps
Using commands Learn command structure and the top 8 commands
Working with workflows Understand workflow progression and quality gates
Configuring providers Set up Codex, Gemini, and cost awareness
Command reference Complete reference for all 39+ commands