Skip to main content
Create a new instance

Usage

Arguments

integer
required
id of instance type to launch (returned from search offers)

Options

string
Create instance from template info
string
User to use with docker create. This breaks some images, so only use this if you are certain you need it.
number
default:"10"
size of local disk partition in GB
string
docker container image to launch
string
docker login arguments for private repo authentication, surround with ”
string
label to set on the instance
string
filename to use as onstart script
string
contents of onstart script as single argument
string
override entrypoint for args launch instance
boolean
Launch as an ssh instance type
boolean
Launch as a jupyter instance instead of an ssh instance
boolean
Use (faster) direct connections for jupyter & ssh
string
For runtype ‘jupyter’, directory in instance to use to launch jupyter. Defaults to image’s working directory
boolean
For runtype ‘jupyter’, Launch instance with jupyter lab
boolean
Workaround for images with locale problems: install and generate locales before instance launch, and set locale to C.UTF-8
boolean
Workaround for images with locale problems: set python’s locale to C.UTF-8
string
env variables and port mapping options, surround with ”
string
list of arguments passed to container ENTRYPOINT. Onstart is recommended for this purpose. (must be last argument)
boolean
Skip sanity checks when creating from an existing instance
boolean
Return error if scheduling fails (rather than creating a stopped instance)
number
(OPTIONAL) create an INTERRUPTIBLE instance with per machine bid price in $/hour
integer
Create a new local volume using an ID returned from the “search volumes” command and link it to the new instance
ID of an existing rented volume to link to the instance during creation. (returned from “show volumes” cmd)
integer
Size of the volume to create in GB. Only usable with --create-volume (default 15GB)
string
The path to the volume from within the new instance container. e.g. /root/volume
string
(optional) A name to give the new volume. Only usable with --create-volume

Description

Performs the same action as pressing the “RENT” button on the website at https://console.vast.ai/create/ Creates an instance from an offer ID (which is returned from “search offers”). Each offer ID can only be used to create one instance. Besides the offer ID, you must pass in an ‘--image’ argument as a minimum. If you use args/entrypoint launch mode, we create a container from your image as is, without attempting to inject ssh and or jupyter. If you use the args launch mode, you can override the entrypoint with --entrypoint, and pass arguments to the entrypoint with --args. If you use --args, that must be the last argument, as any following tokens are consumed into the args string. For ssh/jupyter launch types, use --onstart-cmd to pass in startup script, instead of --entrypoint and --args.

Examples

Global Options

The following options are available for all commands: