Skip to main content

Jobs CLI

Manage jobs

These commands connect to a running CodeBolt server. All subcommands inherit the global codebolt command options --port <number>, --host <string>, and --json.

Subcommands

SubcommandDescriptionArgsOptions
listList all jobs01
getGet job details by ID10
createCreate a new job03
deleteDelete a job by ID10
statsShow job statistics00
readyList jobs that are ready to execute00
blockedList blocked jobs00

list

List all jobs

codebolt command jobs list [options]

Arguments

This command takes no positional arguments.

Options

FlagsRequiredDescription
--status <status>NoFilter by status

get

Get job details by ID

codebolt command jobs get <id>

Arguments

ArgumentDescription
<id>Job ID

Options

This command takes no options.

create

Create a new job

codebolt command jobs create [options]

Arguments

This command takes no positional arguments.

Options

FlagsRequiredDescription
--title <title>YesJob title
--description <text>NoJob description
--priority <level>NoJob priority

delete

Delete a job by ID

codebolt command jobs delete <id>

Arguments

ArgumentDescription
<id>Job ID

Options

This command takes no options.

stats

Show job statistics

codebolt command jobs stats

Arguments

This command takes no positional arguments.

Options

This command takes no options.

ready

List jobs that are ready to execute

codebolt command jobs ready

Arguments

This command takes no positional arguments.

Options

This command takes no options.

blocked

List blocked jobs

codebolt command jobs blocked

Arguments

This command takes no positional arguments.

Options

This command takes no options.