This document contains the help content for the ev command-line program. Command Overview:

​
ev

CLI for the Eventual cloud platform Usage: ev <COMMAND>
Subcommands:
  • auth — Authentication commands
  • completion — Generate completion scripts for the Eventual CLI
  • examples — Generate a minimal example showing how to define and submit a Job using the ev-sdk
  • init — Configure ev to work with your Eventual cloud account
  • jobs — Manage and monitor jobs on the Eventual cloud platform
  • run — Run an Eventual job on the cloud platform
  • spaces — Manage spaces on the Eventual cloud platform

​
ev auth

Authentication commands Usage: ev auth <COMMAND>
Subcommands:
  • login — Login to your account
  • logout — Logout from your account

​
ev auth login

Login to your account Usage: ev auth login

​
ev auth logout

Logout from your account Usage: ev auth logout

​
ev completion

Generate shell completion scripts for the Eventual CLI. The shell completion script provides tab-completion for commands, subcommands, and options. The script must be sourced or installed to provide interactive completion. Examples: 
# Bash - source directly
source <(ev completion bash)

# Bash - install permanently
ev completion bash > /etc/bash_completion.d/ev

# Zsh - source directly
source <(ev completion zsh)

# Zsh - install permanently
ev completion zsh > ~/.zsh/completions/_ev

# Fish - source directly
ev completion fish | source

# Fish - install permanently
ev completion fish > ~/.config/fish/completions/ev.fish

# PowerShell - source directly
ev completion powershell | Out-String | Invoke-Expression

# PowerShell - install permanently
ev completion powershell >> $PROFILE
Usage: ev completion <SHELL>
Arguments:
  • <SHELL> Possible values: bash, elvish, fish, powershell, zsh

​
ev examples

Generate a minimal example showing how to define and submit a Job using the ev-sdk Usage: ev examples <FOLDER>
Arguments:
  • <FOLDER> — Path to a folder where an example project will be written

​
ev init

Configure ev to work with your Eventual cloud account Usage: ev init

​
ev jobs

Manage and monitor jobs on the Eventual cloud platform Usage: ev jobs <COMMAND>
Subcommands:
  • status — Show details for a specific job
  • list — List all jobs
  • logs — Get logs for a specified job

​
ev jobs status

Show details for a specific job Usage: ev jobs status [OPTIONS] <JOB_ID>
Arguments:
  • <JOB_ID> — ID of the job to show
Options:
  • -o, --output <OUTPUT> Default value: table

​
ev jobs list

List all jobs Usage: ev jobs list [OPTIONS] Command Alias: ls
Options:
  • --status <STATUS> — Filter jobs by status. Valid values are: submitted, running, succeeded, failed, stopped, preparing_resources
  • -o, --output <OUTPUT> Default value: table

​
ev jobs logs

Get logs for a specified job Usage: ev jobs logs [OPTIONS] <JOB_ID>
Arguments:
  • <JOB_ID> — ID of the job to get logs for
Options:
  • -o, --output <OUTPUT> Default value: table

​
ev run

Runs an eventual job remotely on the Eventual platform. For example, if you have a job defined as my_job in my_file.py, then you would do ev run my_file.py:my_job. If the file only contains a single Job object, then you can omit the object’s name.
  1. Virtual Environment: ev will run your code in the virtual environment specified by the job’s Env argument.
  2. Persisted Logs/Metrics: ev will persist your run’s logs and metrics on the Eventual Platform
  3. Managed Infrastructure: ev will automatically find the appropriate machine type and handle job autoscaling
Example: 
ev run job.py
Usage: ev run [JOB_REFERENCE] [JOB_ARGS]...
Arguments:
  • <JOB_REFERENCE> — The job reference is given as either file.py:object or file.py
  • <JOB_ARGS> — Additional arguments passed to the job’s main function in --param value format, these MUST match the job.main function signature
Options:
  • --help

​
ev spaces

Manage spaces on the Eventual cloud platform. This command provides operations for managing your spaces in the Eventual cloud. Spaces allow you to organize your projects and resources in the Eventual cloud. Example: 
ev spaces create --name my-space
ev spaces list
ev spaces show --name my-space
Usage: ev spaces <COMMAND>
Subcommands:
  • create — Creates a new space
  • list — Lists all spaces
  • show — Shows details for a specific space
  • use — Uses this space to run jobs

​
ev spaces create

Creates a new space Usage: ev spaces create <NAME>
Arguments:
  • <NAME> — Name of the space to create

​
ev spaces list

List all available spaces. Example: 
ev spaces list
Tip: You can use the -o json flag to output the result in JSON format. This can be combined with other commands such as jq to filter or process the output. Example: 
ev spaces list -o json | jq '.[].name'
Usage: ev spaces list [OPTIONS] Command Alias: ls
Options:
  • -o, --output <OUTPUT> Default value: table

​
ev spaces show

Show details for a specific space By default it will show information about your ‘default’ space set in your configuration file. Additionally, you can specify a space by its ID or name to show its details. Example: 
ev spaces show
ev spaces show --name my-space
ev spaces show --id space-12345
Usage: ev spaces show [OPTIONS]
Options:
  • --id <ID> — ID of the space to show (one of these is required)
  • --name <NAME> — Name of the space to show (one of these is required)

​
ev spaces use

Sets the space to use when running jobs. You can provide either the space’s name or identifier. Example: 
ev spaces use my-space
ev spaces show space-12345
Usage: ev spaces use <NAME_OR_ID>
Arguments:
  • <NAME_OR_ID> — Name or ID of the space to use