vh execution

vh execution

Execution-related commands.

vh execution [OPTIONS] COMMAND [ARGS]...

delete

Delete one or more executions, optionally purging their outputs as well.

vh execution delete [OPTIONS] [COUNTERS]...

Options

--purge-outputs, --no-purge-outputs

purge outputs of the executions too

Arguments

COUNTERS

Optional argument(s)

info

Show execution info.

vh execution info [OPTIONS] COUNTER

Arguments

COUNTER

Required argument

list

Show a list of executions for the project.

vh execution list [OPTIONS]

Options

--status <status>

Filter by status (default: all)

Options:complete|crashed|created|error|incomplete|queued|started|stopped|stopping
-n, --count, --limit <count>

How many executions to show

logs

Show or stream execution event log.

vh execution logs [OPTIONS] COUNTER

Options

--status, --no-status

Show status messages

--stderr, --no-stderr

Show stderr messages

--stdout, --no-stdout

Show stdout messages

--stream, --no-stream

Watch and wait for new messages?

--all, --no-all

Get all messages? This may take a while.

Arguments

COUNTER

Required argument

open

Open an execution in a web browser.

vh execution open [OPTIONS] COUNTER

Arguments

COUNTER

Required argument

outputs

List and download execution outputs.

vh execution outputs [OPTIONS] COUNTER

Options

-d, --download <download_directory>

Download files to this directory (by default, don’t download). You can use `{counter}` as a placeholder that will be replaced by the execution’s counter number.

-f, --filter-download <filter_download>

Download only files matching this glob.

--force

Download all files even if they already exist.

-s, --sync

Keep watching for new output files to download.

Arguments

COUNTER

Required argument

run

Start an execution of a step.

vh execution run [OPTIONS] STEP-NAME STEP-
                 OPTIONS...

Options

-c, --commit <commit>

The commit to use. Defaults to the current HEAD.

-e, --environment <environment>

The environment UUID or slug to use (see `vh env`)

-i, --image <image>

Override the Docker image specified in the step.

-t, --title <title>

Title of the execution.

-w, --watch

Start `exec watch`ing the execution after it starts.

-v, --var <environment_variables>

Add environment variable (NAME=VALUE). May be repeated.

-s, --sync <sync>

Download execution outputs to DIRECTORY.

-a, --adhoc

Upload the current state of the working directory, then run it as an ad-hoc execution.

--validate-adhoc, --no-validate-adhoc

Enable or disable validation of adhoc packaged code, on by default

Arguments

STEP-NAME

Optional argument

STEP-OPTIONS...

Optional argument(s)

stop

Stop one or more in-progress executions.

vh execution stop [OPTIONS] [COUNTERS]...

Options

--all

Stop all in-progress executions.

Arguments

COUNTERS

Optional argument(s)

summarize

Summarize execution metadata.

Use the global –table-format switch to output JSON/TSV/CSV/…

vh execution summarize [OPTIONS] COUNTERS...

Arguments

COUNTERS

Required argument(s)

watch

Watch execution progress in a console UI.

vh execution watch [OPTIONS] COUNTER

Arguments

COUNTER

Required argument