CLI Reference

Complete reference for all rp CLI commands.

Authentication

`rp auth login`

Authenticate with runpiper.

rp auth login

Opens a browser to authenticate with your runpiper Cloud account.

`rp auth logout`

Log out from the current session.

rp auth logout

Tasks

`rp task init`

Create a new Taskfile template.

rp task init [name]

Arguments:

name - Optional name for the task

Example:

rp task init my-task

Creates a my-task.toml file with a template configuration.

`rp task push`

Push a task to create a preview version.

rp task push <taskfile>

Arguments:

taskfile - Path to the Taskfile

Example:

rp task push my-task.toml

`rp task deploy`

Deploy a task to production.

rp task deploy <name> [--version <version>]

Arguments:

name - Task name

Options:

--version - Specific version to deploy (optional, uses latest if not specified)

Example:

rp task deploy my-task
rp task deploy my-task --version v2

`rp task test`

Test a task with input data.

rp task test <name> --input <json>

Arguments:

name - Task name

Options:

--input - JSON input for the task (required)

Example:

rp task test my-task --input '{"message": "Hello"}'

`rp task list`

List all tasks.

rp task list [--live|--preview]

Options:

--live - Show only production tasks
--preview - Show only preview tasks
(Default) - Show all tasks

Examples:

rp task list                    # All tasks
rp task list --live            # Production only
rp task list --preview         # Preview only

`rp task pull`

Download a Taskfile from the server.

rp task pull <name>

Arguments:

name - Task name

Example:

rp task pull my-task

Downloads the Taskfile to <name>.toml.

`rp task delete`

Delete a task.

rp task delete <name>

Arguments:

name - Task name

Example:

rp task delete my-task

`rp task validate`

Validate a Taskfile.

rp task validate <taskfile>

Arguments:

taskfile - Path to the Taskfile

Example:

rp task validate my-task.toml

Checks the Taskfile for syntax errors and missing required fields.

`rp task gen-test`

Generate a test input file for a task.

rp task gen-test <name>

Arguments:

name - Task name

Example:

rp task gen-test my-task

Creates a sample input file based on the task’s prompt template.

Self-Hosted

`rp init`

Bootstrap a new self-hosted instance.

rp init

Prompts for:

Admin key (from runpiper_ADMIN_KEY environment variable)
Server endpoint (e.g., http://localhost:8080)
Admin email address
Organization name

Creates the first admin user without requiring an invite code.

`rp serve`

Start a self-hosted runpiper server.

rp serve

Starts the server on the configured endpoint (default: http://localhost:8080).

Invite Management

`rp invite create`

Create an invite code for a user.

rp invite create <email> [--expires-days <days>]

Arguments:

email - Email address for the invite

Options:

--expires-days - Number of days until invite expires (default: 7)

Example:

rp invite create user@example.com
rp invite create user@example.com --expires-days 30

You must be logged into a self-hosted instance to create invites.

`rp invite list`

List all invite codes.

rp invite list

Shows all active and expired invite codes.

`rp invite revoke`

Revoke an invite code.

rp invite revoke <email>

Arguments:

email - Email address to revoke

Example:

rp invite revoke user@example.com

Other

`rp update`

Update the CLI to the latest version.

rp update

Downloads and installs the latest version of the runpiper CLI.

Global Options

All commands support these global options:

-h, --help - Show help information
-v, --version - Show version information
--config <path> - Use specific config file

Environment Variables

Variable	Description
`runpiper_ADMIN_KEY`	Admin key for bootstrapping self-hosted instances
`runpiper_CONFIG`	Path to configuration file
`DATABASE_URL`	Database connection string

Configuration Files

`.env`

Store environment variables:

runpiper_ADMIN_KEY=your-secret-key
DATABASE_URL=postgresql://user:pass@localhost:5432/runpiper

`config.toml`

runpiper configuration file. Create from example:

cp config.toml.example config.toml

See Self-Hosted Deployment for full configuration details.

Exit Codes

Code	Meaning
0	Success
1	General error
2	Usage error
3	Network error
4	Authentication error
5	Validation error

Next Steps

Tasks: Learn about tasks
Self-Hosted Deployment: Deploy your own instance
API Documentation: HTTP API reference