Skip to main content

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.

Images are the base templates used when creating compute instances. You can use public images or create custom ones. Aliases: images, img

​
Subcommands

​
list

List available images, optionally filtered by organization and region. 
nscale images list [flags]

​
Flags

FlagDescription
--org stringOrganization ID
--region stringRegion ID
--jsonOutput in JSON format

​
Example

nscale images list --org <org-id> --region <region-id>

​
create

Create a new custom image. Accepts input from a JSON file or stdin. 
nscale images create [flags]

​
Flags

FlagDescription
--org stringOrganization ID
--region stringRegion ID
-f, --file stringPath to a JSON file
--stdinRead JSON from standard input
--dry-runPreview the request payload without persisting
-y, --yesAutomatically confirm creation

​
Examples

nscale images create --file image.json
nscale images create --stdin < image.json
cat image.json | nscale images create --stdin

​
delete

Delete an existing image. 
nscale images delete --id <image-id> [flags]

​
Flags

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

​
Example

nscale images delete --id <image-id> --org <org-id> --yes

Custom Images (Console)

Upload and use custom OS images via the Console UI.