RunWield Documentation

RunWield helps you review what an AI plans to do before it changes your code, then verifies the result. Use this manual to install RunWield, start a Session, understand its workflows, and configure it for your project.

RunWield builds on Pi. These pages explain RunWield-specific behavior and link to Pi when the behavior is unchanged. Visit the RunWield website for the product overview.

Start

Install RunWield

On macOS or Linux:

curl -fsSL https://raw.githubusercontent.com/gandazgul/runwield/main/install.sh | bash

Make sure ~/.local/bin is on your PATH, then start RunWield from your project root:

wld

On first use, connect a model provider when prompted. Then initialize the project and make a request:

/init
fix the failing parser test

• Quickstart — install, authenticate, initialize a project, and run your first request.
• Workspace — use RunWield in a browser or on your phone.
• Connect for Claude Code — keep the conversation and model calls in Claude Code, with Core workflow gates. Core needs no model credentials for Connect; this FEATURE Preview has its own tested scope.
• Connect for Codex — use $runwield:run in the desktop app or CLI. The adapter is available for FEATURE Preview qualification; complete live workflows on these surfaces remain unqualified.

Use RunWield

• Using RunWield — commands, Agents, Work Records, and where RunWield keeps its data.
• Plans and workflows — how requests are routed, reviewed, executed, and verified.
• Sessions — resume work, name Sessions, and run background tasks.
• Self-hosted collaboration — share Plans for review through your own Plan Server.

Configure RunWield

• Providers and models — credentials, model selection, and CLI backends.
• Settings reference — global and project settings.
• Customization — Agent overrides, prompt templates, and Skills.
• Themes — select and install terminal themes.
• MCP — connect Model Context Protocol servers.

Get help

• Troubleshooting — resolve common installation and runtime problems.

For terminal editing, keybindings, and other inherited behavior, use the Pi documentation.

Want to change RunWield itself? See Contributing.