CLI Reference
Rover command reference.
Table of Contents
Section titled “Table of Contents”Project configuration
Section titled “Project configuration”Initialize your project
Usage:
rover init [options] [path]Options:
-y, --yes: Skip all confirmations and run non-interactively
Create and manage tasks
Section titled “Create and manage tasks”Start a new task for an AI Agent. It will spawn a new environment to complete it.
Usage:
rover task [options] [description]Options:
--from-github <issue>: Fetch task description from a GitHub issue number-y, --yes: Skip all confirmations and run non-interactively-s, --source-branch <branch>: Base branch for git worktree creation-t, --target-branch <branch>: Custom name for the worktree branch-a, --agent <agent>: AI agent to use (claude, gemini, qwen)--json: Output the result in JSON format--debug: Show debug information like running commands
restart
Section titled “restart”Restart a new or failed task
Usage:
rover restart [options] <taskId>Options:
--json: Output the result in JSON format
Stop a running task and clean up its resources
Usage:
rover stop [options] <taskId>Options:
-a, --remove-all: Remove container, git worktree and branch if they exist-c, --remove-container: Remove container if it exists-g, --remove-git-worktree-and-branch: Remove git worktree and branch--json: Output the result in JSON format
Show tasks and their status
Usage:
rover list [options]Options:
-w, --watch: Watch for changes and refresh every 5 seconds--json: Output in JSON format
Aliases: ls
inspect
Section titled “inspect”Inspect a task
Usage:
rover inspect [options] <taskId> [iterationNumber]Options:
--file <files...>: Output iteration file contents--json: Output in JSON format
Show execution logs for a task iteration
Usage:
rover logs [options] <taskId> [iterationNumber]Options:
-f, --follow: Follow log output in real-time--json: Output the result in JSON format
delete
Section titled “delete”Delete a task
Usage:
rover delete [options] <taskId...>Options:
-y, --yes: Skip all confirmations and run non-interactively--json: Output in JSON format
Aliases: del
iterate
Section titled “iterate”Add instructions to a task and start new iteration
Usage:
rover iterate [options] <taskId> [instructions]Options:
-f, --follow: Follow execution logs in real-time--json: Output JSON and skip confirmation prompts
Aliases: iter
Debug a task
Section titled “Debug a task”Open interactive shell for testing task changes
Usage:
rover shell [options] <taskId>Options:
-c, --container: Start the interactive shell within a container
Merge changes
Section titled “Merge changes”Show git diff between task worktree and main branch
Usage:
rover diff [options] <taskId> [filePath]Options:
-b, --branch <name>: Compare changes with a specific branch--only-files: Show only changed filenames
Merge the task changes into your current branch
Usage:
rover merge [options] <taskId>Options:
-f, --force: Force merge without confirmation--json: Output in JSON format
Commit and push task changes to remote, with GitHub PR support
Usage:
rover push [options] <taskId>Options:
-m, --message <message>: Commit message--json: Output in JSON format