CLICommand referencejob
job
Commands, arguments, and options for openship job.
See the workflow guide for examples. Global flags such as --json go before the command; see global options.
openship job
Manage self-hosted jobs, schedules, and run logs
openship job|jobs [options] [command]| Subcommand | Purpose |
|---|---|
list | List system and custom jobs |
get <key> | Show a job's configuration and recent runs |
create [options] | Create a custom job (name, server, command, and schedule required) |
update [options] <key> | Update a job; built-ins accept schedule and enabled changes |
delete|rm [options] <key> | Delete a custom job (system jobs cannot be deleted) |
run [options] <key> | Run a job now; custom jobs return a run ID |
runs [options] <key> | List a job's run history |
logs [options] <runId> | Show stored run output, or the full run in JSON mode |
events | List event types available as job triggers |
backup-schedules | List scheduled backups with their next and last runs |
openship job backup-schedules
List scheduled backups with their next and last runs
openship job backup-schedules [options]openship job create
Create a custom job (name, server, command, and schedule required)
openship job create [options]| Option | Meaning |
|---|---|
--name <name> | Job label |
--server <id> | Target server ID |
--command <command> | Shell command to execute on the server |
--schedule <type> | Schedule type (choices: "recurring", "once", "manual") |
--cron <expression> | Five-field cron expression |
--at <iso> | Run time for a once schedule |
--file <path> | JSON API body (env, secrets, retry, etc.); flags override file values |
openship job delete
Delete a custom job (system jobs cannot be deleted)
openship job delete|rm [options] <key>| Option | Meaning |
|---|---|
-y, --yes | Confirm deletion |
openship job events
List event types available as job triggers
openship job events [options]openship job get
Show a job's configuration and recent runs
openship job get [options] <key>openship job list
List system and custom jobs
openship job list [options]openship job logs
Show stored run output, or the full run in JSON mode
openship job logs [options] <runId>| Option | Meaning |
|---|---|
-f, --follow | Stream output until completion; exit nonzero on failure |
openship job run
Run a job now; custom jobs return a run ID
openship job run [options] <key>| Option | Meaning |
|---|---|
-f, --follow | Stream the custom run until completion |
openship job runs
List a job's run history
openship job runs [options] <key>| Option | Meaning |
|---|---|
--limit <n> | Maximum number of runs (default 50) |
openship job update
Update a job; built-ins accept schedule and enabled changes
openship job update [options] <key>| Option | Meaning |
|---|---|
--name <name> | Job label |
--server <id> | Target server ID |
--command <command> | Shell command to execute on the server |
--schedule <type> | Schedule type (choices: "recurring", "once", "manual") |
--cron <expression> | Five-field cron expression |
--at <iso> | Run time for a once schedule |
--file <path> | JSON API body (env, secrets, retry, etc.); flags override file values |
--enabled | Enable the job |
--no-enabled | Disable the job |