Skip to main content
Projects help organize resources within an organization.

​
Subcommands

  • list — List projects
  • get — Get project details
  • create — Create a new project
  • update — Update an existing project
  • delete — Delete a project

​
list

List projects in an organization. 
nscale projects list --org <org-id> [flags]

​
Flags

FlagDescription
—org stringOrganization ID
—jsonEmit the full JSON payload (mutually exclusive with -q)
-q, —query stringArrayjq filter for value extraction (see Query output with -q)

​
get

Get details for a specific project. 
nscale projects get --id <project-id> --org <org-id>

​
Flags

FlagDescription
—id stringProject ID
—org stringOrganization ID
—jsonEmit the full JSON payload (mutually exclusive with -q)
-q, —query stringArrayjq filter for value extraction (see Query output with -q)

​
create

Create a new project in the specified organization. Supports interactive mode or JSON input. 
nscale projects create --org <org-id> [flags]

​
Flags

FlagDescription
—org stringOrganization ID
-f, —file stringPath to a JSON file
—stdinRead JSON from standard input
—dry-runPreview the request payload without persisting
-y, —yesAutomatically confirm creation
—jsonEmit the full JSON payload (mutually exclusive with -q)
-q, —query stringArrayjq filter for value extraction (see Query output with -q)

​
Examples

nscale projects create --org <org-id> --file project.json
nscale projects create --org <org-id> --stdin < project.json
cat project.json | nscale projects create --org <org-id> --stdin
# Interactive mode
nscale projects create

​
update

Update an existing project. 
nscale projects update --org <org-id> --id <project-id> [flags]

​
Flags

FlagDescription
—id stringProject ID
—org stringOrganization ID
-f, —file stringPath to a JSON file
—stdinRead JSON from standard input
—dry-runPreview the request payload without persisting
-y, —yesAutomatically confirm update
—jsonEmit the full JSON payload (mutually exclusive with -q)
-q, —query stringArrayjq filter for value extraction (see Query output with -q)

​
Examples

nscale projects update --org <org-id> --id <project-id> --file project.json
nscale projects update --org <org-id> --id <project-id> --stdin < project.json
cat project.json | nscale projects update --org <org-id> --id <project-id> --stdin

​
delete

Delete an existing project. 
nscale projects delete --org <org-id> --id <project-id> [flags]

​
Flags

FlagDescription
--id stringProject ID
--org stringOrganization ID
--dry-runPreview the request payload without persisting
-y, --yesAutomatically confirm deletion