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.
Groups allow you to organize users and control access to resources within an organization.
Subcommands
- list — List groups
- get — Get group details
- create — Create a new group
- update — Update an existing group
- delete — Delete a group
list
List groups in an organization.
nscale groups 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 group.
nscale groups get --id <group-id> --org <org-id>
Flags
| Flag | Description |
|---|
—id string | Group 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 group in the specified organization. Supports interactive mode or JSON input.
nscale groups 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 groups create --org <org-id> --file group.json
nscale groups create --org <org-id> --stdin < group.json
cat group.json | nscale groups create --org <org-id> --stdin
# Interactive mode
nscale groups create
update
Update an existing group.
nscale groups update --org <org-id> --id <group-id> [flags]
Flags
| Flag | Description |
|---|
—id string | Group 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 groups update --org <org-id> --id <group-id> --file group.json
nscale groups update --org <org-id> --id <group-id> --stdin < group.json
cat group.json | nscale groups update --org <org-id> --id <group-id> --stdin
delete
Delete an existing group.
nscale groups delete --org <org-id> --id <group-id> [flags]
Flags
| Flag | Description |
|---|
--id string | Group ID |
--org string | Organization ID |
--dry-run | Preview the request payload without persisting |
-y, --yes | Automatically confirm deletion |
