'crane'¶

Crane CLI plugins:

Usage:

$ 'crane' [OPTIONS] COMMAND [ARGS]...

Options:

• -V, --version: Print Crane CLI version [default: False]
• --install-completion: Install completion for the current shell.
• --show-completion: Show completion for the current shell, to copy it or customize the installation.
• --help: Show this message and exit.

Commands:

• config: Configuration related commands.
• job: job related commands
• resource: crane resource related commands
• user: user related commands
• ws: workspace related commands

'crane' config¶

Configuration related commands.

Usage:

$ 'crane' config [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• list: Get current crane url.
• set: Set new configuration.

'crane' config list¶

Get current crane url.

Usage:

$ 'crane' config list [OPTIONS]

Options:

• --help: Show this message and exit.

'crane' config set¶

Set new configuration.

Right now, only url can be configured.

Usage:

$ 'crane' config set [OPTIONS] VALUE

Arguments:

• VALUE: [required]

Options:

• --help: Show this message and exit.

'crane' job¶

job related commands

Usage:

$ 'crane' job [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• add: Add a new job to crane cluster.
• inspect: Show detailed job information.
• kill: Kill jobs (send a unix signal to each job).
• list: List jobs with given query.
• log: Get log of job.
• remove: Remove multiple jobs.
• rm: Remove multiple jobs.

'crane' job add¶

Add a new job to crane cluster.

Launch a job with [image] and [resource] image is specified in docker image format resource is specified as [app gpu]:[min gpu]:[max gpu] can be specified as [app gpu] or [app gpu]:[total gpu]

Usage:

$ 'crane' job add [OPTIONS] IMAGE RESOURCE

Arguments:

• IMAGE: [required]
• RESOURCE: [required]

Options:

• -c, --cmd TEXT: Command to run. If not provided, defaults to command in docker image.
• -e, --env TEXT: Environment variables in [key]=[value] format. [default: ]
• -m, --mount TEXT: Mount config in [host_dir]:[container_dir]:[option] format.For host directory, Crane supports relative path as well. [default: ]
• -p, --port INTEGER: Assign private port. [default: ]
• -pp, --public-port INTEGER: Assign public port. [default: ]
• --rdma / --no-rdma: If set, allow rdma use. [default: False]
• / --no-overlay: No AM overlay network needed. [default: False]
• --shm-size TEXT: The size of /dev/shm in containers. Default is 64m. [default: 64m]
• -n, --name TEXT: Job name. Must be unique per user
• -t, --tag TEXT: job tags [default: ]
• --shell / --no-shell: If true, the command will be executed through the shell. [default: False]
• --init / --no_init: If true, run an init inside the container. [default: True]
• --help: Show this message and exit.

'crane' job inspect¶

Show detailed job information.

Usage:

$ 'crane' job inspect [OPTIONS] [ID_OR_NAME]

Arguments:

• [ID_OR_NAME]: Job ID or name, or its prefix (the first n letters of id/name).

Options:

• -t, --tag TEXT: List of job tags [default: ]
• --format TEXT: Formatting template.
• --help: Show this message and exit.

'crane' job kill¶

Kill jobs (send a unix signal to each job).

Usage:

$ 'crane' job kill [OPTIONS] [ID_OR_NAME]

Arguments:

• [ID_OR_NAME]: Job ID or name, or its prefix (the first n letters of id/name).

Options:

• -t, --tag TEXT: List of job tags [default: ]
• --force: [default: False]
• -y, --yes: Automatic yes to prompt. [default: False]
• --help: Show this message and exit.

'crane' job list¶

List jobs with given query.

Usage:

$ 'crane' job list [OPTIONS] [ID_OR_NAME]

Arguments:

• [ID_OR_NAME]: Job ID or name, or its prefix (the first n letters of id/name).

Options:

• -t, --tag TEXT: List of job tags [default: ]
• -a, --all: [default: False]
• -q, --quiet: Prints the names of jobs only. [env var: CRANE_CLI_QUIET; default: False]
• --help: Show this message and exit.

'crane' job log¶

Get log of job.

Usage:

$ 'crane' job log [OPTIONS] [ID_OR_NAME]

Arguments:

• [ID_OR_NAME]: Job ID or name, or its prefix (the first n letters of id/name).

Options:

• -t, --tag TEXT: List of job tags [default: ]
• -f, --follow: [default: False]
• --stderr: Prints stderr logs only. [default: False]
• --stdout: Prints stdout logs only. [default: False]
• --timestamp: Show timestamp [default: False]
• --since [%Y-%m-%d|%Y-%m-%dT%H:%M:%S|%Y-%m-%d %H:%M:%S]: Timestamp in iso 8601 format
• --help: Show this message and exit.

'crane' job remove¶

Remove multiple jobs.

Removing a job will remove every information about the job including logs. You cannot remove a job that is not terminated unless forced.

Usage:

$ 'crane' job remove [OPTIONS] [ID_OR_NAME]

Arguments:

• [ID_OR_NAME]

Options:

• -t, --tag TEXT: job tag [default: ]
• --force / --no-force: Force move a job. [default: False]
• --help: Show this message and exit.

'crane' job rm¶

Remove multiple jobs.

Removing a job will remove every information about the job including logs. You cannot remove a job that is not terminated unless forced.

Usage:

$ 'crane' job rm [OPTIONS] [ID_OR_NAME]

Arguments:

• [ID_OR_NAME]

Options:

• -t, --tag TEXT: job tag [default: ]
• --force / --no-force: Force move a job. [default: False]
• --help: Show this message and exit.

'crane' resource¶

crane resource related commands

Usage:

$ 'crane' resource [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• all: Show all cluster resource.

'crane' resource all¶

Show all cluster resource.

Usage:

$ 'crane' resource all [OPTIONS]

Options:

• --help: Show this message and exit.

'crane' user¶

user related commands

Usage:

$ 'crane' user [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• signin: Sign in to crane.
• signout: Sign out of crane.
• whoami: See current logged in user information.

'crane' user signin¶

Sign in to crane.

Usage:

$ 'crane' user signin [OPTIONS]

Options:

• --web / --no-web: Whether to automatically open a web browser. [default: True]
• --help: Show this message and exit.

'crane' user signout¶

Sign out of crane.

Usage:

$ 'crane' user signout [OPTIONS]

Options:

• --help: Show this message and exit.

'crane' user whoami¶

See current logged in user information.

Usage:

$ 'crane' user whoami [OPTIONS]

Options:

• --help: Show this message and exit.

'crane' ws¶

workspace related commands

Usage:

$ 'crane' ws [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• init: Initialize current directory as Crane...

'crane' ws init¶

Initialize current directory as Crane workspace.

Usage:

$ 'crane' ws init [OPTIONS]

Options:

• --help: Show this message and exit.