project Beta

Manage your Paperspace projects.

Global Flags

These flags are available on all commands.

–log-level, -l (string, optional)

Enable debug logging. One of debug, info, warning, error, or critical.

–json, -j (boolean, optional)

Output JSON

–api-key (string, optional)

A Paperspace public API Key used for authenticating requests

–help, -h (boolean, optional)

Show help for a command

---

pspace project create

Create a new project. This command prompts you for a name if you don’t provide one.

Arguments

Create a project with these properties.

[argument] (string, required)

Flags

–fields, -F (string, optional)

The fields to include in the response.

Global Flags

These flags are available on all commands.

–log-level, -l (string, optional)

Enable debug logging. One of debug, info, warning, error, or critical.

–json, -j (boolean, optional)

Output JSON

–api-key (string, optional)

A Paperspace public API Key used for authenticating requests

–help, -h (boolean, optional)

Show help for a command

---

pspace project get

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

Arguments

[argument] (string, required)

The project ID to get.

Flags

–fields, -F (string, optional)

The fields to include in the response.

Global Flags

These flags are available on all commands.

–log-level, -l (string, optional)

Enable debug logging. One of debug, info, warning, error, or critical.

–json, -j (boolean, optional)

Output JSON

–api-key (string, optional)

A Paperspace public API Key used for authenticating requests

–help, -h (boolean, optional)

Show help for a command

---

pspace project list

List projects in your team.

Pick a subset of fields to display:

pspace project list -F id -F name -F dtCreated

Flags

–limit (number, optional)

The number of items to return in the next page.

–after (string, optional)

The cursor to fetch the next results from.

–orderBy (string, optional)

The field to order items by. One of dtCreated.

–asc (boolean, optional)

Whether to order items ascending.

–desc (boolean, optional)

Whether to order items descending.

–fields, -F (string, optional)

The fields to include in the response.

Global Flags

These flags are available on all commands.

–log-level, -l (string, optional)

Enable debug logging. One of debug, info, warning, error, or critical.

–json, -j (boolean, optional)

Output JSON

–api-key (string, optional)

A Paperspace public API Key used for authenticating requests

–help, -h (boolean, optional)

Show help for a command

---

pspace project update

Update an existing project.

Example:

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

Arguments

[argument] (string, required)

The project ID to update.

Flags

–name (string, optional)

The new name for the project.

–fields, -F (string, optional)

The fields to include in the response.

Global Flags

These flags are available on all commands.

–log-level, -l (string, optional)

Enable debug logging. One of debug, info, warning, error, or critical.

–json, -j (boolean, optional)

Output JSON

–api-key (string, optional)

A Paperspace public API Key used for authenticating requests

–help, -h (boolean, optional)

Show help for a command

---

pspace project link

This command links a remote project to a local directory. Commands that depend on a project ID use the project ID of the linked project when communicating with the Paperspace API.

Link a project to the current directory.

$ pspace link

Link a project to a different directory.

$ pspace link --cwd ../my-app

Link a project and specify a project ID.

$ pspace link pzwf2g05ubegj

Arguments

A project ID. If not provided, you are prompted to select one.

[argument] (string, required)

The project ID.

Flags

–cwd (string, optional)

The directory to link the project to. Defaults to the current directory.

Global Flags

These flags are available on all commands.

–log-level, -l (string, optional)

Enable debug logging. One of debug, info, warning, error, or critical.

–json, -j (boolean, optional)

Output JSON

–api-key (string, optional)

A Paperspace public API Key used for authenticating requests

–help, -h (boolean, optional)

Show help for a command