Skip to main content

projects

Paperspace Gradient CLI reference guide for projects.

create

Create new project

Examples

gradient projects create \
--name "New Project"

Options

NameTypeAttributesDescription
--namestringrequiredProject name
--repositoryNamestringoptionalName of the repository
--repositoryUrlstringoptionalURL to the repository
--tagstringoptionalOne or many tags that you want to add
--tagsstringoptionalTags separated by comma
--apiKeystringoptionalAPI key to use this time only
--optionsFilestringoptionalPath to YAML with predefined options
--createOptionsFilestringoptionalGenerate template options file

Response

Project created with ID: prmximcci
https://console.paperspace.com/paperspace-docs-team/projects/prmximcci

details

Show details of a project

Examples

gradient projects details \
--id "prmximcci"

Options

NameTypeAttributesDescription
--idstringrequiredProject ID
--apiKeystringoptionalAPI key to use this time only
--optionsFilestringoptionalPath to YAML with predefined options
--createOptionsFilestringoptionalGenerate template options file

Response

+-----------------+-------------+
| Name | New Project |
+-----------------+-------------+
| ID | prmximcci |
| Repository name | None |
| Repository url | None |
| Tags | |
+-----------------+-------------+

list

Show details of a project

Examples

gradient projects list

Options

NameTypeAttributesDescription
--tagstringoptionalFilter by tags
--apiKeystringoptionalAPI key to use this time only
--optionsFilestringoptionalPath to YAML with predefined options
--createOptionsFilestringoptionalGenerate template options file

Response

+-----------+----------------+------------+----------------------------+
| ID | Name | Repository | Created |
+-----------+----------------+------------+----------------------------+
| prmximcci | New Project | None | 2022-03-22 06:34:52.360000 |
+-----------+----------------+------------+----------------------------+

delete

Delete project

Examples

gradient projects delete \
--id "prmximcci"

Options

NameTypeAttributesDescription
--idstringrequiredProject ID
--apiKeystringoptionalAPI key to use this time only
--optionsFilestringoptionalPath to YAML with predefined options
--createOptionsFilestringoptionalGenerate template options file

Response

Project deleted

tags add

Add tags to project

Examples

gradient projects tags add \
--id "prmximcci" \
--tag "PyTorch"

Options

NameTypeAttributesDescription
--idstringrequiredProject ID
--tagstringoptionalOne or many tags you want to add to project
--tagsstringoptionalSeparated by comma tags that you want to add to project
--apiKeystringoptionalAPI key to use this time only
--optionsFilestringoptionalPath to YAML with predefined options
--createOptionsFilestringoptionalGenerate template options file

Response

Tags added to project

tags remove

Remove tags from project

Examples

gradient projects tags remove \
--id "prmximcci" \
--tag "PyTorch"

Options

NameTypeAttributesDescription
--idstringrequiredProject ID
--tagstringoptionalOne or many tags you want to add to project
--tagsstringoptionalSeparated by comma tags that you want to add to project
--apiKeystringoptionalAPI key to use this time only
--optionsFilestringoptionalPath to YAML with predefined options
--createOptionsFilestringoptionalGenerate template options file

Response

Tags removed from project