shipper setup
shipper setup
Section titled “shipper setup”Usage: shipper setup [options] [words…]
Aliases: shipper agent
Configure repository settings with an agent
Arguments
Section titled “Arguments”| Argument | Required | Description | Choices |
|---|---|---|---|
| [words…] | no | - | - |
| Long | Short | Value | Default | Description | Choices |
|---|---|---|---|---|---|
| —mode | - | default | execution mode: headless, interactive, or default | headless, interactive, default | |
| —agent | - | - | agent to use: claude, codex, copilot, or opencode | claude, codex, copilot, opencode | |
| —model | - | - | model to use for the agent CLI | - | |
| —disable-mcp | - | - | - | disable MCP server loading for this run | - |
| —enable-mcp | - | - | - | enable MCP server loading for this run | - |
Examples
Section titled “Examples”Run setup with additional instructions for the agent.
shipper setup "change the default agent to codex"Exit Codes
Section titled “Exit Codes”| Code | When |
|---|---|
| 0 | Setup completes successfully or opens and adopts a setup PR into the normal Shipper workflow. |
| 1 | Setup validation, agent execution, setup finalization, or setup PR adoption after PR creation fails. |
Constraints
Section titled “Constraints”- —disable-mcp and —enable-mcp are mutually exclusive
- Headless mode is not supported for shipper setup; run setup interactively or remove “commands.setup.mode”: “headless” / “commands.default.mode”: “headless” from .shipper/settings.json.
- Accepted setup finalization opens the setup PR, adopts it into a tracking issue at
shipper:pr-open, and directs you to return to the base branch before continuing withshipper next <issue>orshipper ship <issue>. - Troubleshooting: GitHub authentication problems
- Troubleshooting: worktree creation and install command failures
- Troubleshooting: MCP tool loading issues