Skip to main content
Contexts let you store named configurations — including organization, project, region, and user credentials — so you don’t need to pass these flags on every command. Contexts are persisted in the user configuration folder. For example, on macOS they are stored in ~/.config/nscale/contexts.yaml. Aliases: context, ctx

Subcommands

  • set — Create or update a context
  • use — Set the current active context
  • list — List all contexts
  • delete — Delete a context
  • clear — Clear the current context

set

Create or update a context with a given name, organization, and user. The --org, --project, and --region flags expect resource IDs, not names. Use nscale organizations list, nscale projects list, and nscale regions list to discover the IDs. Any flag that is omitted will be prompted for interactively.
nscale contexts set --name <name> --org <organization-id> [--project <project-id>] [--region <region-id>] [--user <user>]

Flags

FlagDescription
--name stringContext name
--org stringOrganization ID
--project stringProject ID
--region stringRegion ID
--user stringKeyring user credentials to use

Examples

nscale contexts set --name prod --user default --org <organization-id> --project <project-id> --region <region-id>
For interactive mode (prompts for all values):
nscale contexts set

use

Set the current active context. All subsequent commands will use this context unless overridden with --context.
nscale contexts use <name>

Example

nscale contexts use prod

list

List all configured contexts. Aliases: list, ls
nscale contexts list

delete

Delete a context by name. Aliases: delete, rm, remove
nscale contexts delete <name>

Example

nscale contexts delete prod

clear

Clear the current active context. After clearing, commands will require explicit flags for organization, project, etc.
nscale contexts clear