Clone, build, and run agents with scorpiox
| Flag | Short | Description | Takes Value |
|---|---|---|---|
--repo |
-r |
Repository URL to clone the agent from | Yes |
--branch |
-b |
Git branch to clone (default: main) | Yes |
--pat |
-p |
Personal access token for private repos | Yes |
--model |
-m |
LLM model to use for the agent session | Yes |
--id |
-i |
Task instance ID (default: auto-generated UUID) | Yes |
--cwd |
— |
Working directory for the agent session | Yes |
--prompt |
— |
Initial prompt to send to the agent | Yes |
--sln |
-s |
Solution file for .NET agent builds | Yes |
--dll |
-d |
DLL entry point for .NET agent | Yes |
--tui |
— |
TUI executable to use for interactive mode | Yes |
--provider |
— |
LLM provider (for --sdk mode) | Yes |
--session-id |
— |
Session ID (for --sdk mode) | Yes |
--cache-dir |
— |
Override agent cache directory | Yes |
--task-dir-base |
— |
Override task instances base directory | Yes |
--diag |
— |
Show all resolved paths and exit | Yes |
-e |
— |
Environment variable to pass to agent | Yes |
--force |
— |
Rebuild even if cached | No |
--no-build |
— |
Skip dotnet build step | No |
--no-clone |
-n |
Skip git clone step | No |
--sdk |
— |
SDK mode: exec scorpiox-sdk --print instead of TUI | No |
--pipe-claude |
— |
Pipe CLAUDE.md content as stdin (default: off) | No |
--print-task-dir |
— |
Print task directory and exit (for SDK) | No |
--dry-run |
— |
Show what would be done without executing | No |
--diagnose |
— |
Run full diagnostics | No |
--list |
-l |
List cached agents | No |
--help |
-h |
Show help message | No |
# Clone and run an agent from a public repo scorpiox-agent --repo https://github.com/myorg/my-agent.git # Specify a branch scorpiox-agent -r https://github.com/myorg/my-agent.git -b develop
# Use a personal access token for private repos scorpiox-agent --repo https://git.example.com/org/agent.git --pat ghp_xxxxxxxxxxxx # Combine with a specific model scorpiox-agent -r https://git.example.com/org/agent.git -p ghp_xxx -m claude-sonnet-4-20250514
# Set a working directory and initial prompt scorpiox-agent --repo https://github.com/myorg/agent.git --cwd /home/user/project --prompt "Analyze this codebase and generate a report"
# Run in SDK mode (outputs JSON instead of TUI) scorpiox-agent --repo https://github.com/myorg/agent.git --sdk --provider anthropic --session-id abc-123 # Print task directory path (useful in scripts) scorpiox-agent --repo https://github.com/myorg/agent.git --print-task-dir /root/.scorpiox/task_instances/a1b2c3d4-...
# List all cached agents scorpiox-agent --list # Force rebuild even if agent is cached scorpiox-agent --repo https://github.com/myorg/agent.git --force # Use a custom cache directory scorpiox-agent --repo https://github.com/myorg/agent.git --cache-dir /tmp/agent-cache # Skip clone (use existing source) and skip build scorpiox-agent --no-clone --no-build --repo https://github.com/myorg/agent.git
# Specify .NET solution and DLL entry point scorpiox-agent --repo https://github.com/myorg/dotnet-agent.git --sln Agent.sln --dll bin/Release/Agent.dll
# Run diagnostics to check paths and configuration scorpiox-agent --diagnose # Show all resolved paths scorpiox-agent --diag paths # Dry run — show plan without executing scorpiox-agent --repo https://github.com/myorg/agent.git --dry-run
# Pass environment variables to agent scorpiox-agent -r https://github.com/myorg/agent.git -e API_KEY=sk-xxx -e ENV=production # Pipe CLAUDE.md instead of using system prompt scorpiox-agent --repo https://github.com/myorg/agent.git --pipe-claude
scorpiox/scorpiox-agent.clibsxutil