Paperspace CLI

Installation

Using Shell (macOS, Linux, and Windows using WSL):

curl -fsSL https://console.paperspace.com/install.sh | sh

Using Scoop (Windows):

Note Coming soon

scoop bucket add pspace https://github.com/Paperspace/scoop-bucket.git
scoop install pspace

Using Homebrew (macOS and Linux):

Note Coming soon

brew tap paperspace/tap
brew install pspace

Usage

Run pspace --help in your terminal.

pspace [command] [flags]

Available Commands

Command	Description
`pspace`	A CLI for using the Paperspace API.
`pspace completion`	Generate an autocompletion script for the specified shell
`pspace completion bash`	Generate an autocompletion script for the bash shell
`pspace completion fish`	Generate an autocompletion script for the fish shell
`pspace completion zsh`	Generate an autocompletion script for the zsh shell
`pspace config`	Manage your local Paperspace configuration.
`pspace config delete`	Delete a configuration value.
`pspace config get`	Get a configuration value.
`pspace config set`	Set a configuration value.
`pspace console`	Open the Paperspace web console.
`pspace deployment`	Effortlessly deploy ML apps to Paperspace.
`pspace deployment get`
`pspace deployment init`
`pspace deployment list`
`pspace deployment up`
`pspace docs`	Open Paperspace documention in your default browser.
`pspace help`	Show help for a pspace command
`pspace help commands`	List pspace commands
`pspace login`	Log in to the CLI.
`pspace logout`	Log out of the CLI.
`pspace project`	Manage your Paperspace projects.
`pspace project create`	Create a new project
`pspace project get`	Get a project.
`pspace project list`	List projects.
`pspace project update`	Update an existing project.
`pspace signup`	Sign up for a Paperspace account.
`pspace upgrade`	Upgrade �[1mpspace�[22m to the latest version.
`pspace version`	Show version information

`$ pspace`

A CLI for using the Paperspace API.

It allows you to authenticate, launch deployments, do logging, and more.

Deploy an ML app with the deployment command
View a deployed app with the deployment open command
Check the status of a deployment with the deployment status command

Read the full documentation at: https://docs.paperspace.com/

Global Flags

These flags are available on all commands.

Name	Type	Required?	Description
--log-level, -l	`"debug" \| "info" \| "warning" \| "error" \| "critical"`	No	Enable debug logging. Options are: debug, info, warning, error, and critical
--json, -j	`boolean`	No	Output JSON
--api-key	`string`	No	A Paperspace public API Key used for authenticating requests
--help, -h	`boolean`	No	Show help for a command

⇗ Back to top

`$ pspace completion`

Generate an autocompletion script for pspace in the specified shell. See each sub-command's help for details on how to use the generated script.

Global Flags

These flags are available on all commands.

Name	Type	Required?	Description
--log-level, -l	`"debug" \| "info" \| "warning" \| "error" \| "critical"`	No	Enable debug logging. Options are: debug, info, warning, error, and critical
--json, -j	`boolean`	No	Output JSON
--api-key	`string`	No	A Paperspace public API Key used for authenticating requests
--help, -h	`boolean`	No	Show help for a command

⇗ Back to top

`$ pspace completion bash`

Generate the autocompletion script for the bash shell.

This script depends on the bash-completion package. If it is not installed already, you can install it via your OS's package manager.

To load completions in your current shell session:

$ source <(pspace completion bash)

To load completions for every new session, execute once:

Linux:

$ pspace completion bash > /etc/bash_completion.d/pspace

MacOS:

$ pspace completion bash > /usr/local/etc/bash_completion.d/pspace

You will need to start a new shell for this setup to take effect.

Global Flags

These flags are available on all commands.

Name	Type	Required?	Description
--log-level, -l	`"debug" \| "info" \| "warning" \| "error" \| "critical"`	No	Enable debug logging. Options are: debug, info, warning, error, and critical
--json, -j	`boolean`	No	Output JSON
--api-key	`string`	No	A Paperspace public API Key used for authenticating requests
--help, -h	`boolean`	No	Show help for a command

⇗ Back to top

`$ pspace completion fish`

Generate the autocompletion script for the fish shell.

To load completions in your current shell session:

$ pspace completion fish | source

To load completions for every new session, execute once:

$ pspace completion fish > ~/.config/fish/completions/pspace.fish

You will need to start a new shell for this setup to take effect.

Flags

Name	Type	Required?	Default	Description
--no-descriptions	`boolean`	No		Disable completion descriptions

Global Flags

These flags are available on all commands.

Name	Type	Required?	Description
--log-level, -l	`"debug" \| "info" \| "warning" \| "error" \| "critical"`	No	Enable debug logging. Options are: debug, info, warning, error, and critical
--json, -j	`boolean`	No	Output JSON
--api-key	`string`	No	A Paperspace public API Key used for authenticating requests
--help, -h	`boolean`	No	Show help for a command

⇗ Back to top

`$ pspace completion zsh`

Generate the autocompletion script for the zsh shell.

If shell completion is not already enabled in your environment you will need to enable it. You can execute the following once:

$ echo "autoload -U compinit; compinit" >> ~/.zshrc

To load completions for every new session, execute once:

Linux:

$ pspace completion zsh > "${fpath[1]}/_pspace"

macOS:

$ pspace completion zsh > /usr/local/share/zsh/site-functions/_pspace

Oh My Zsh:

$ pspace completion zsh > ~/.oh-my-zsh/completions/_pspace

You will need to start a new shell for this setup to take effect.

Flags

Name	Type	Required?	Default	Description
--no-descriptions	`boolean`	No		Disable completion descriptions

Global Flags

These flags are available on all commands.

Name	Type	Required?	Description
--log-level, -l	`"debug" \| "info" \| "warning" \| "error" \| "critical"`	No	Enable debug logging. Options are: debug, info, warning, error, and critical
--json, -j	`boolean`	No	Output JSON
--api-key	`string`	No	A Paperspace public API Key used for authenticating requests
--help, -h	`boolean`	No	Show help for a command

⇗ Back to top

`$ pspace config`

This command manages your Paperspace configuration. You can use it to set, get, and delete configuration values. Running this command without any subcommands will print your current configuration.

Your configuration is stored in a TOML file at ~/.paperspace/config.toml.

For example, to set the current team, run:

pspace config set team "my-team"

Global Flags

These flags are available on all commands.

Name	Type	Required?	Description
--log-level, -l	`"debug" \| "info" \| "warning" \| "error" \| "critical"`	No	Enable debug logging. Options are: debug, info, warning, error, and critical
--json, -j	`boolean`	No	Output JSON
--api-key	`string`	No	A Paperspace public API Key used for authenticating requests
--help, -h	`boolean`	No	Show help for a command

⇗ Back to top

`$ pspace config delete`

Delete a configuration value.

Arguments

The key to delete.

Type	Variadic?	Description
`"version" \| "team" \| "locale"`	No	The configuration key.

Global Flags

These flags are available on all commands.

Name	Type	Required?	Description
--log-level, -l	`"debug" \| "info" \| "warning" \| "error" \| "critical"`	No	Enable debug logging. Options are: debug, info, warning, error, and critical
--json, -j	`boolean`	No	Output JSON
--api-key	`string`	No	A Paperspace public API Key used for authenticating requests
--help, -h	`boolean`	No	Show help for a command

⇗ Back to top

`$ pspace config get`

This command gets a configuration value. You can pass a key to get a specific value, or you can pass no arguments to get all configuration values.

For example, to get the current team run:

pspace config get team

Arguments

The key to get.

Type	Variadic?	Description
`"version" \| "team" \| "locale"`	No	The configuration key.

Global Flags

These flags are available on all commands.

Name	Type	Required?	Description
--log-level, -l	`"debug" \| "info" \| "warning" \| "error" \| "critical"`	No	Enable debug logging. Options are: debug, info, warning, error, and critical
--json, -j	`boolean`	No	Output JSON
--api-key	`string`	No	A Paperspace public API Key used for authenticating requests
--help, -h	`boolean`	No	Show help for a command

⇗ Back to top

`$ pspace config set`

Set a configuration value.

Arguments

The key/value pair to set.

Type	Variadic?	Description
`"version" \| "team" \| "locale"`	No	The configuration key.
`string`	No	The new configuration value.

Global Flags

These flags are available on all commands.

Name	Type	Required?	Description
--log-level, -l	`"debug" \| "info" \| "warning" \| "error" \| "critical"`	No	Enable debug logging. Options are: debug, info, warning, error, and critical
--json, -j	`boolean`	No	Output JSON
--api-key	`string`	No	A Paperspace public API Key used for authenticating requests
--help, -h	`boolean`	No	Show help for a command

⇗ Back to top

`$ pspace console`

This command opens the Paperspace web console in your browser.

Global Flags

These flags are available on all commands.

Name	Type	Required?	Description
--log-level, -l	`"debug" \| "info" \| "warning" \| "error" \| "critical"`	No	Enable debug logging. Options are: debug, info, warning, error, and critical
--json, -j	`boolean`	No	Output JSON
--api-key	`string`	No	A Paperspace public API Key used for authenticating requests
--help, -h	`boolean`	No	Show help for a command

⇗ Back to top

`$ pspace deployment`

Effortlessly deploy ML apps to Paperspace.

Global Flags

These flags are available on all commands.

Name	Type	Required?	Description
--log-level, -l	`"debug" \| "info" \| "warning" \| "error" \| "critical"`	No	Enable debug logging. Options are: debug, info, warning, error, and critical
--json, -j	`boolean`	No	Output JSON
--api-key	`string`	No	A Paperspace public API Key used for authenticating requests
--help, -h	`boolean`	No	Show help for a command

⇗ Back to top

`$ pspace deployment get`

Global Flags

These flags are available on all commands.

Name	Type	Required?	Description
--log-level, -l	`"debug" \| "info" \| "warning" \| "error" \| "critical"`	No	Enable debug logging. Options are: debug, info, warning, error, and critical
--json, -j	`boolean`	No	Output JSON
--api-key	`string`	No	A Paperspace public API Key used for authenticating requests
--help, -h	`boolean`	No	Show help for a command

⇗ Back to top

`$ pspace deployment init`

Global Flags

These flags are available on all commands.

Name	Type	Required?	Description
--log-level, -l	`"debug" \| "info" \| "warning" \| "error" \| "critical"`	No	Enable debug logging. Options are: debug, info, warning, error, and critical
--json, -j	`boolean`	No	Output JSON
--api-key	`string`	No	A Paperspace public API Key used for authenticating requests
--help, -h	`boolean`	No	Show help for a command

⇗ Back to top

`$ pspace deployment list`

Global Flags

These flags are available on all commands.

Name	Type	Required?	Description
--log-level, -l	`"debug" \| "info" \| "warning" \| "error" \| "critical"`	No	Enable debug logging. Options are: debug, info, warning, error, and critical
--json, -j	`boolean`	No	Output JSON
--api-key	`string`	No	A Paperspace public API Key used for authenticating requests
--help, -h	`boolean`	No	Show help for a command

⇗ Back to top

`$ pspace deployment up`

Global Flags

These flags are available on all commands.

Name	Type	Required?	Description
--log-level, -l	`"debug" \| "info" \| "warning" \| "error" \| "critical"`	No	Enable debug logging. Options are: debug, info, warning, error, and critical
--json, -j	`boolean`	No	Output JSON
--api-key	`string`	No	A Paperspace public API Key used for authenticating requests
--help, -h	`boolean`	No	Show help for a command

⇗ Back to top

`$ pspace docs`

This command opens the Paperspace documentation in your browser. You can optionally pass an argument that will take you to a specific docs page.

Valid pages are:

d, deployment

Arguments

Type	Variadic?	Description
`"d" \| "deployment"`	No	The page to open

Global Flags

These flags are available on all commands.

Name	Type	Required?	Description
--log-level, -l	`"debug" \| "info" \| "warning" \| "error" \| "critical"`	No	Enable debug logging. Options are: debug, info, warning, error, and critical
--json, -j	`boolean`	No	Output JSON
--api-key	`string`	No	A Paperspace public API Key used for authenticating requests
--help, -h	`boolean`	No	Show help for a command

⇗ Back to top

`$ pspace help`

Show help for a pspace command

Arguments

Type	Variadic?	Description
`"project" \| "deployment" \| "upgrade" \| "config" \| "signup" \| "console" \| "docs" \| "logout" \| "login" \| "version" \| "completion" \| "help"`	No	The command to show help for.

Global Flags

These flags are available on all commands.

Name	Type	Required?	Description
--log-level, -l	`"debug" \| "info" \| "warning" \| "error" \| "critical"`	No	Enable debug logging. Options are: debug, info, warning, error, and critical
--json, -j	`boolean`	No	Output JSON
--api-key	`string`	No	A Paperspace public API Key used for authenticating requests
--help, -h	`boolean`	No	Show help for a command

⇗ Back to top

`$ pspace help commands`

List pspace commands

Flags

Name	Type	Required?	Default	Description
--all, -a	`boolean`	No		Show all commands, including hidden ones

Global Flags

These flags are available on all commands.

Name	Type	Required?	Description
--log-level, -l	`"debug" \| "info" \| "warning" \| "error" \| "critical"`	No	Enable debug logging. Options are: debug, info, warning, error, and critical
--json, -j	`boolean`	No	Output JSON
--api-key	`string`	No	A Paperspace public API Key used for authenticating requests
--help, -h	`boolean`	No	Show help for a command

⇗ Back to top

`$ pspace login`

Log in to the CLI using your Paperspace API key or by opening the web console.

Arguments

Type	Variadic?	Description
`string`	No	An API key to log in with.

Global Flags

These flags are available on all commands.

Name	Type	Required?	Description
--log-level, -l	`"debug" \| "info" \| "warning" \| "error" \| "critical"`	No	Enable debug logging. Options are: debug, info, warning, error, and critical
--json, -j	`boolean`	No	Output JSON
--api-key	`string`	No	A Paperspace public API Key used for authenticating requests
--help, -h	`boolean`	No	Show help for a command

⇗ Back to top

`$ pspace logout`

Log out of the CLI for the current team, a specific team, or all teams.

Arguments

The teams to logout of.

Type	Variadic?	Description
`string`	Yes	The team to logout of.

Flags

Name	Type	Required?	Default	Description
--all, -a	`boolean`	No		Log out of all teams.

Global Flags

These flags are available on all commands.

Name	Type	Required?	Description
--log-level, -l	`"debug" \| "info" \| "warning" \| "error" \| "critical"`	No	Enable debug logging. Options are: debug, info, warning, error, and critical
--json, -j	`boolean`	No	Output JSON
--api-key	`string`	No	A Paperspace public API Key used for authenticating requests
--help, -h	`boolean`	No	Show help for a command

⇗ Back to top

`$ pspace project`

Manage your Paperspace projects.

Global Flags

These flags are available on all commands.

Name	Type	Required?	Description
--log-level, -l	`"debug" \| "info" \| "warning" \| "error" \| "critical"`	No	Enable debug logging. Options are: debug, info, warning, error, and critical
--json, -j	`boolean`	No	Output JSON
--api-key	`string`	No	A Paperspace public API Key used for authenticating requests
--help, -h	`boolean`	No	Show help for a command

⇗ Back to top

`$ pspace project create`

Create a new project. This command will prompt you for a name if you don't provide one.

Arguments

Create a project with these properties.

Type	Variadic?	Description
`string`	No

Flags

Name	Type	Required?	Default	Description
--fields, -F	`string`	No		The fields to include in the response.

Global Flags

These flags are available on all commands.

Name	Type	Required?	Description
--log-level, -l	`"debug" \| "info" \| "warning" \| "error" \| "critical"`	No	Enable debug logging. Options are: debug, info, warning, error, and critical
--json, -j	`boolean`	No	Output JSON
--api-key	`string`	No	A Paperspace public API Key used for authenticating requests
--help, -h	`boolean`	No	Show help for a command

⇗ Back to top

`$ pspace project get`

Get a project by its ID. If you don't provide an ID, this command will prompt you for one based on the projects you have access to.

Arguments

Type	Variadic?	Description
`string`	No	The project ID to get.

Flags

Name	Type	Required?	Default	Description
--fields, -F	`string`	No		The fields to include in the response.

Global Flags

These flags are available on all commands.

Name	Type	Required?	Description
--log-level, -l	`"debug" \| "info" \| "warning" \| "error" \| "critical"`	No	Enable debug logging. Options are: debug, info, warning, error, and critical
--json, -j	`boolean`	No	Output JSON
--api-key	`string`	No	A Paperspace public API Key used for authenticating requests
--help, -h	`boolean`	No	Show help for a command

⇗ Back to top

`$ pspace project list`

List projects in your team.

Examples:

Pick a subset of fields to display:

zcli.json -F handle -F name -F dtCreated

Flags

Name	Type	Required?	Description
--limit	`number`	No	The number of projects to return in the next page.
--after	`string`	No	The cursor to fetch the next results from.
--orderBy	`"dtCreated"`	No	The field to order projects by.
--asc	`boolean`	No	Whether to order projects ascending.
--desc	`boolean`	No	Whether to order projects descending.
--fields, -F	`string`	No	The fields to include in the response.

Global Flags

These flags are available on all commands.

Name	Type	Required?	Description
--log-level, -l	`"debug" \| "info" \| "warning" \| "error" \| "critical"`	No	Enable debug logging. Options are: debug, info, warning, error, and critical
--json, -j	`boolean`	No	Output JSON
--api-key	`string`	No	A Paperspace public API Key used for authenticating requests
--help, -h	`boolean`	No	Show help for a command

⇗ Back to top

`$ pspace project update`

Update an existing project.

Example:

pspace project update psukfyemho7 --name my-cool-project

Arguments

Type	Variadic?	Description
`string`	No	The project ID to update.

Flags

Name	Type	Required?	Default	Description
--name	`string`	No		The new name for the project.
--fields, -F	`string`	No		The fields to include in the response.

Global Flags

These flags are available on all commands.

Name	Type	Required?	Description
--log-level, -l	`"debug" \| "info" \| "warning" \| "error" \| "critical"`	No	Enable debug logging. Options are: debug, info, warning, error, and critical
--json, -j	`boolean`	No	Output JSON
--api-key	`string`	No	A Paperspace public API Key used for authenticating requests
--help, -h	`boolean`	No	Show help for a command

⇗ Back to top

`$ pspace signup`

This command opens the Paperspace signup page in your browser.

Global Flags

These flags are available on all commands.

Name	Type	Required?	Description
--log-level, -l	`"debug" \| "info" \| "warning" \| "error" \| "critical"`	No	Enable debug logging. Options are: debug, info, warning, error, and critical
--json, -j	`boolean`	No	Output JSON
--api-key	`string`	No	A Paperspace public API Key used for authenticating requests
--help, -h	`boolean`	No	Show help for a command

⇗ Back to top

`$ pspace upgrade`

This command upgrades �[1mpspace�[22m to the latest version.

If you used a package manager like brew to install pspace, you should use that to upgrade in order to avoid potential permissions issues. For example, for brew you can upgrade by running:

brew upgrade pspace

If you installed pspace using the install script, you can upgrade by running:

pspace upgrade

Global Flags

These flags are available on all commands.

Name	Type	Required?	Description
--log-level, -l	`"debug" \| "info" \| "warning" \| "error" \| "critical"`	No	Enable debug logging. Options are: debug, info, warning, error, and critical
--json, -j	`boolean`	No	Output JSON
--api-key	`string`	No	A Paperspace public API Key used for authenticating requests
--help, -h	`boolean`	No	Show help for a command

⇗ Back to top

`$ pspace version`

Shows version information command, including version number and build date.

Global Flags

These flags are available on all commands.

Name	Type	Required?	Description
--log-level, -l	`"debug" \| "info" \| "warning" \| "error" \| "critical"`	No	Enable debug logging. Options are: debug, info, warning, error, and critical
--json, -j	`boolean`	No	Output JSON
--api-key	`string`	No	A Paperspace public API Key used for authenticating requests
--help, -h	`boolean`	No	Show help for a command

⇗ Back to top

Name		Name	Last commit message	Last commit date
Latest commit History 25 Commits
.assets		.assets
.github/workflows		.github/workflows
.scripts		.scripts
.vscode		.vscode
api		api
commands		commands
lib		lib
prompts		prompts
test		test
.gitignore		.gitignore
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE		LICENSE
README.md		README.md
cache.ts		cache.ts
config.ts		config.ts
credentials.ts		credentials.ts
deno.jsonc		deno.jsonc
deno.lock		deno.lock
deps.ts		deps.ts
env.ts		env.ts
errors.ts		errors.ts
flags.ts		flags.ts
logger.ts		logger.ts
mod.ts		mod.ts
release.config.js		release.config.js
spec.yaml		spec.yaml
version.ts		version.ts
zcli.ts		zcli.ts

License

Paperspace/cli

Folders and files

Latest commit

History

Repository files navigation

Paperspace CLI

Installation

Usage

Available Commands

$ pspace

Global Flags

$ pspace completion

Global Flags

$ pspace completion bash

Global Flags

$ pspace completion fish

Flags

Global Flags

$ pspace completion zsh

Flags

Global Flags

$ pspace config

Global Flags

$ pspace config delete

Arguments

Global Flags

$ pspace config get

Arguments

Global Flags

$ pspace config set

Arguments

Global Flags

$ pspace console

Global Flags

$ pspace deployment

Global Flags

$ pspace deployment get

Global Flags

$ pspace deployment init

Global Flags

$ pspace deployment list

Global Flags

$ pspace deployment up

Global Flags

$ pspace docs

Arguments

Global Flags

$ pspace help

Arguments

Global Flags

$ pspace help commands

Flags

Global Flags

$ pspace login

Arguments

Global Flags

$ pspace logout

Arguments

Flags

Global Flags

$ pspace project

Global Flags

$ pspace project create

Arguments

Flags

Global Flags

$ pspace project get

Arguments

Flags

Global Flags

$ pspace project list

Flags

Global Flags

$ pspace project update

Arguments

Flags

Global Flags

$ pspace signup

Global Flags

`$ pspace`

`$ pspace completion`

`$ pspace completion bash`

`$ pspace completion fish`

`$ pspace completion zsh`

`$ pspace config`

`$ pspace config delete`

`$ pspace config get`

`$ pspace config set`

`$ pspace console`

`$ pspace deployment`

`$ pspace deployment get`

`$ pspace deployment init`

`$ pspace deployment list`

`$ pspace deployment up`

`$ pspace docs`

`$ pspace help`

`$ pspace help commands`

`$ pspace login`

`$ pspace logout`

`$ pspace project`

`$ pspace project create`

`$ pspace project get`

`$ pspace project list`

`$ pspace project update`

`$ pspace signup`

`$ pspace upgrade`

`$ pspace version`

Packages