Skip to main content

Use the CLI with jobs

Submit and monitor jobs with the v8x

Use the CLI with jobs

Use the v8x to inspect available job scripts, create job submissions, and monitor their progress.

note

Job commands are currently under active development. While the command group is present, some functionality may still be evolving.

Inspect the job commands

If this is your first time using the job commands, start with:

uvx v8x job --help
uvx v8x job script list --help
uvx v8x job submission create --help
uvx v8x job submission list --help

The most important commands in this workflow are:

  • uvx v8x job script list to find an existing job script you can submit
  • uvx v8x job submission create to create a new submission from a job script
  • uvx v8x job submission list and uvx v8x job submission get to monitor the resulting workload

Find a job script

List the job scripts available to your account:

uvx v8x job script list

This returns the job scripts you can submit. Use the output to identify the numeric job script ID you want to run.

Key options:

  • --search to filter by name or text
  • --user-only to focus on your own scripts
  • --limit and --offset to page through results
  • --json to return machine-readable output

Success looks like this: the script you want to run appears in the list with an ID that you can use in the next step.

Create a submission

Create a job submission from an existing job script:

uvx v8x job submission create --name my-first-submission --job-script-id 123

This creates a new job submission record and sends it to the platform for scheduling.

Key options:

  • --name, required, to label the submission
  • --job-script-id, required, to choose the script to run
  • --description to add context for teammates
  • --execution-directory if the workload needs a specific working directory
  • --sbatch-arg to pass one or more scheduler arguments

Success looks like this: the command returns a new submission ID, which you can use to monitor the workload.

Monitor submissions

List your current submissions:

uvx v8x job submission list

Inspect one submission in detail:

uvx v8x job submission get 789

These commands let you track the lifecycle of a submission after it has been accepted.

Key options:

  • --search and sorting flags on list to narrow large result sets
  • --json on both commands when you want to parse status programmatically

Success looks like this: the list shows your submission, and the get command returns its current state and metadata.

What next

Ask AI
Ask a question about Vantage Compute...