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.
Aliases: instances, inst
Subcommands
- list — List instances
- get — Get instance details
- create — Create a new instance
- update — Update an existing instance
- delete — Delete an instance
- start — Start an instance
- stop — Stop an instance
- reboot — Reboot an instance
- snapshot — Create a snapshot from an instance
- ssh — Open an SSH session to an instance
- sshkey — Get an instance’s SSH key
- consoleoutput — Get instance console output
- consolesession — Get a VNC console session URL
list
List compute instances, optionally filtered by organization, project, network, or region.
nscale instances list [flags]
Flags
| Flag | Description |
|---|
--org string | Organization ID |
--project string | Project ID |
--network string | Network ID |
--region string | Region ID |
--json | Output in JSON format |
Example
nscale instances list --org <org-id> --region <region-id>
get
Get details for a specific instance in JSON format.
nscale instances get --id <instance-id> --org <org-id>
Flags
| Flag | Description |
|---|
--id string | Instance ID |
--org string | Organization ID |
create
Create a new compute instance. Accepts input from a JSON file or stdin. Optionally supply a cloud-init configuration.
nscale instances create [flags]
Flags
| Flag | Description |
|---|
-f, --file string | Path to a JSON file |
--stdin | Read JSON from standard input |
--cloud-init-path string | Path to a cloud-init YAML file |
--dry-run | Preview the request payload without persisting |
-y, --yes | Automatically confirm creation |
Examples
nscale instances create --file instance.json
nscale instances create --stdin < instance.json
cat instance.json | nscale instances create --stdin
update
Update an existing instance.
nscale instances update --id <instance-id> [flags]
Flags
| Flag | Description |
|---|
--id string | Instance 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 |
Examples
nscale instances update --id <instance-id> --file instance.json
nscale instances update --id <instance-id> --stdin < instance.json
delete
Delete an existing instance.
nscale instances delete --id <instance-id> --org <org-id> [flags]
Flags
| Flag | Description |
|---|
--id string | Instance ID |
--org string | Organization ID |
--dry-run | Preview the request payload without persisting |
-y, --yes | Automatically confirm deletion |
start
Start a stopped instance.
nscale instances start --id <instance-id> --org <org-id> [flags]
Flags
| Flag | Description |
|---|
--id string | Instance ID |
--org string | Organization ID |
--dry-run | Preview the request payload without persisting |
-y, --yes | Automatically confirm start |
stop
Stop a running instance.
nscale instances stop --id <instance-id> --org <org-id> [flags]
Flags
| Flag | Description |
|---|
--id string | Instance ID |
--org string | Organization ID |
--dry-run | Preview the request payload without persisting |
-y, --yes | Automatically confirm stop |
reboot
Reboot an instance. Use --hard for a hard reboot.
nscale instances reboot --id <instance-id> --org <org-id> [flags]
Flags
| Flag | Description |
|---|
--id string | Instance ID |
--org string | Organization ID |
--hard | Use hard reboot |
--dry-run | Preview the request payload without persisting |
-y, --yes | Automatically confirm reboot |
snapshot
Create an image snapshot from an instance. Accepts input from a JSON file or stdin.
nscale instances snapshot --id <instance-id> [flags]
Flags
| Flag | Description |
|---|
--id string | Instance 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 snapshot |
Examples
nscale instances snapshot --id <instance-id> --file snapshot.json
nscale instances snapshot --id <instance-id> --stdin < snapshot.json
ssh
Open an interactive SSH session to an instance using the system SSH client.
nscale instances ssh --id <instance-id> [flags]
Flags
| Flag | Description |
|---|
--id string | Instance ID |
--org string | Organization ID |
-l, --ssh-user string | SSH login user (default: "root") |
Examples
nscale instances ssh --id <instance-id>
nscale instances ssh --org <org-id>
nscale instances ssh --id <instance-id> --ssh-user ubuntu
nscale instances ssh --id <instance-id> -- -L 8443:127.0.0.1:443
sshkey
Get the SSH key for an instance in JSON format.
nscale instances sshkey --id <instance-id> --org <org-id>
Flags
| Flag | Description |
|---|
--id string | Instance ID |
--org string | Organization ID |
consoleoutput
Retrieve the serial console output of an instance.
nscale instances consoleoutput --id <instance-id> --org <org-id> [flags]
Flags
| Flag | Description |
|---|
--id string | Instance ID |
--org string | Organization ID |
--length int | Output length in bytes (0 uses API default) |
--json | Output in JSON format |
consolesession
Get a VNC console session URL for an instance.
nscale instances consolesession --id <instance-id> --org <org-id>
Flags
| Flag | Description |
|---|
--id string | Instance ID |
--org string | Organization ID |
Instances (Console)
Create and manage instances via the Console UI.
Custom Images
Upload and use custom OS images for instances.
