CLI reference

The Runtipi CLI is a command-line tool for managing your Runtipi instance. Use it to control services, manage apps, and configure app stores.

Synopsis


./runtipi-cli <command> [options] [arguments]

Most commands require sudo privileges to manage file permissions and Docker containers. Running without sudo may result in permission errors.

Global options

The following options are available for multiple commands:

--env-file <path> - Use a custom .env file (relative or absolute path)
--no-permissions - Skip file permission checks (not recommended)
--help - Display help for any command

Core commands

`start`

Start the Runtipi instance and all services.


sudo ./runtipi-cli start [--env-file <path>] [--no-permissions]

`stop`

Stop all Runtipi services.


sudo ./runtipi-cli stop

`restart`

Restart Runtipi services.


sudo ./runtipi-cli restart [--env-file <path>] [--no-permissions]

This command checks permissions, copies files, and generates configuration without starting Docker containers.

`update`

Update Runtipi to a specific version.


sudo ./runtipi-cli update <version> [--env-file <path>] [--no-permissions]

Examples:


# Update to latest version
sudo ./runtipi-cli update latest
 
# Update to specific version
sudo ./runtipi-cli update v2.0.7

⚠️

Downgrading to previous versions may break your installation. Always backup before downgrading.

Utility commands

`version`

Display CLI version information.


./runtipi-cli version

Shows version number, commit hash, and build date.

`installed`

List all installed apps.


./runtipi-cli installed

`reset-password`

Reset the admin password.


./runtipi-cli reset-password

After running this command, visit http://<your-ip>/reset-password to set a new password.

`debug`

Display diagnostic information for troubleshooting.


./runtipi-cli debug

`help`

Display help information.


./runtipi-cli help [command]

App management

Manage individual apps using the app subcommand. Apps are identified by <app-id>:<store-name>.

`app start`

Start a specific app.


./runtipi-cli app start <app-id>:<store>

Example:


./runtipi-cli app start code-server:migrated

`app stop`

Stop a running app.


./runtipi-cli app stop <app-id>:<store>

`app restart`

Restart an app.


./runtipi-cli app restart <app-id>:<store>

`app start-all`

Start all installed apps.


./runtipi-cli app start-all

`app update`

Update an app to the latest version.


./runtipi-cli app update <app-id>:<store>

`app uninstall`

Remove an app and its configuration.


./runtipi-cli app uninstall <app-id>:<store>

`app reset`

Reset an app to its initial state.


./runtipi-cli app reset <app-id>:<store>

⚠️

This permanently deletes all app data and settings. Backup important data first.

Backup & restore

`app backup`

Create a backup of an app.


./runtipi-cli app backup <app-id>:<store>

`app restore`

Restore an app from a backup file.


./runtipi-cli app restore <app-id>:<store> <backup-filename>

Example:


./runtipi-cli app restore code-server:migrated backup-20241026-120000.tar.gz

`app list-backups`

List available backups for an app.


./runtipi-cli app list-backups <app-id>:<store>

`app delete-backup`

Delete a specific backup file.


./runtipi-cli app delete-backup <app-id>:<store> <backup-filename>

Appstore management

Manage app stores with the appstore subcommand.

`appstore list`

List all configured app stores.


./runtipi-cli appstore list

`appstore update`

Update all app stores to fetch latest app information.


./runtipi-cli appstore update

`appstore add`

Add a new app store.


./runtipi-cli appstore add <name> <url>

Example:


./runtipi-cli appstore add my-store https://github.com/user/my-appstore

`appstore remove`

Remove an app store.


./runtipi-cli appstore remove <name>

Auto Update with Cron Environment Variables Uninstalling