Documentation Index
Fetch the complete documentation index at: https://docs.nscale.com/llms.txt
Use this file to discover all available pages before exploring further.
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
| Flag | Description |
|---|
—org string | Organization ID |
—json | Emit the full JSON payload (mutually exclusive with -q) |
-q, —query stringArray | jq 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
| Flag | Description |
|---|
—id string | Project ID |
—org string | Organization ID |
—json | Emit the full JSON payload (mutually exclusive with -q) |
-q, —query stringArray | jq 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
| Flag | Description |
|---|
—org string | Organization ID |
-f, —file string | Path to a JSON file |
—stdin | Read JSON from standard input |
—dry-run | Preview the request payload without persisting |
-y, —yes | Automatically confirm creation |
—json | Emit the full JSON payload (mutually exclusive with -q) |
-q, —query stringArray | jq 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
| Flag | Description |
|---|
—id string | Project ID |
—org string | Organization ID |
-f, —file string | Path to a JSON file |
—stdin | Read JSON from standard input |
—dry-run | Preview the request payload without persisting |
-y, —yes | Automatically confirm update |
—json | Emit the full JSON payload (mutually exclusive with -q) |
-q, —query stringArray | jq 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
| Flag | Description |
|---|
--id string | Project ID |
--org string | Organization ID |
--dry-run | Preview the request payload without persisting |
-y, --yes | Automatically confirm deletion |
