CLI Command Reference

Complete reference for all Resplix CLI commands and flags.

$ pit auth login

Authenticate with your Resplix account

USAGE

$ pit auth login [--no-browser]

Examples

$ pit auth login
$ pit auth login --no-browser

$ pit auth logout

Revoke the current authentication token

USAGE

$ pit auth logout

Examples

$ pit auth logout

$ pit backup run

Execute a single backup immediately

USAGE

$ pit backup run [OPTIONS]

Examples

$ pit backup run
$ pit backup run --database prod-db --full

$ pit backup list

List all backups for the current configuration

USAGE

$ pit backup list [--json] [--limit N]

Examples

$ pit backup list
$ pit backup list --limit 100 --json

$ pit backup test

Test database and storage connections

USAGE

$ pit backup test

Examples

$ pit backup test

$ pit backup download

Download a specific backup file

USAGE

$ pit backup download <backup-id> [--output FILE]

Examples

$ pit backup download abc123
$ pit backup download abc123 --output ./backup.tar

$ pit restore start

Initiate a resplix restore workflow

USAGE

$ pit restore start <backup-id> [OPTIONS]

Examples

$ pit restore start abc123
$ pit restore start abc123 --resplix 2024-01-15T10:30:00Z

$ pit restore status

Check the status of an ongoing restore

USAGE

$ pit restore status <restore-id>

Examples

$ pit restore status restore-xyz789

$ pit config validate

Validate the current configuration file

USAGE

$ pit config validate [--file FILE]

Examples

$ pit config validate
$ pit config validate --file custom.yaml

$ pit config show

Display the current configuration (with secrets masked)

USAGE

$ pit config show

Examples

$ pit config show

$ pit schedule list

List all configured backup schedules

USAGE

$ pit schedule list

Examples

$ pit schedule list

$ pit schedule run

Manually trigger a scheduled backup

USAGE

$ pit schedule run <schedule-id>

Examples

$ pit schedule run daily-backup

$ pit logs stream

Stream real-time logs for backup operations

USAGE

$ pit logs stream [--follow] [--lines N]

Examples

$ pit logs stream --follow
$ pit logs stream --lines 100

$ pit logs export

Export logs to a file or stdout

USAGE

$ pit logs export [--output FILE] [--since DURATION]

Examples

$ pit logs export --output backup.log
$ pit logs export --since 24h

$ pit version

Display the installed CLI version

USAGE

$ pit version [--check-updates]

Examples

$ pit version
$ pit version --check-updates

Global Flags

--config FILE

Path to configuration file (default: ./Resplix.yaml)

--debug

Enable debug logging output

--json

Output results in JSON format

--help, -h

Show help message

--version, -v

Show version information