cpln sandbox: Create and manage dev and agent sandboxes, connect to a dev sandbox, and run sessions on an agent sandbox.
Manage sandboxesFor a detailed overview, please visit the sandbox’s reference page.
cpln sandbox [SUBCOMMAND]
The cpln sandbox commands find the org’s sandbox GVC themselves, so --gvc is not needed. A GVC named by --gvc, the CPLN_GVC environment variable, or your profile is used as given.
Commands: cpln sandbox access-report <ref> Show the access report for the referenced sandbox cpln sandbox audit <ref> Retrieve audit trail events for the referenced sandbox cpln sandbox connect <ref> Connect to a dev sandbox: its IDE, terminal, or SSH cpln sandbox create <ref> Create a new sandbox cpln sandbox delete <ref...> Delete one or more referenced sandboxes and their home volumes cpln sandbox edit <ref> Edit the referenced sandbox, as YAML, within an editor cpln sandbox eventlog <ref> Show the event log of the referenced sandbox [aliases: log] cpln sandbox get [ref...] Retrieve one or more referenced sandboxes cpln sandbox patch <ref> Update the referenced sandbox's metadata using an input file cpln sandbox permissions Show the grantable permissions for a sandbox object type cpln sandbox session Manage the sessions of a worker sandbox cpln sandbox start <ref...> Start one or more stopped sandboxes cpln sandbox stop <ref...> Stop one or more sandboxes until they are started; their home volumes are kept cpln sandbox tag <ref...> Manage the tags belonging to one or more referenced sandboxes cpln sandbox update <ref> Update properties of the referenced sandboxOptions: --help Show help [boolean]
sandbox access-report
Show the access report for the referenced sandboxUsage
cpln sandbox access-report <ref> [OPTIONS]
Reference
Positionals: ref The resource reference. Usually it is the name of the resource. [required]Context options: --profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable --org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command --gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` commandFormat options: --output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"] --color Colorize the output [boolean] [default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options: --token Override the authorization token --endpoint Override the API URL --insecure, -k Ignore TLS errors [boolean]Debug options: --verbose, -v Enable verbose output to stderr [boolean] [default: false] --debug, -d Show all HTTP communications [boolean] [default: false]Options: --help Show help [boolean]
Retrieve audit trail events for the referenced sandboxUsage
cpln sandbox audit <ref> [OPTIONS]
Reference
Positionals: ref The resource reference. Usually it is the name of the resource. [required]Command options: --subject Filter by subject (serviceaccount name or user email) [string] --context Audit context name (the 'cpln' context displays Control Plane actions) [string] [default: "cpln"] --since Relative lookback window from now (e.g., 1h, 24h, 7d). Mutually exclusive with --from/--to [string] [default: "7d"] --from Start time for audit events (ISO 8601 format or relative duration, e.g., 2025-10-23T07:00:00Z, 7d, 1h). Cannot be used with --since [string] --to End time for audit events (ISO 8601 format or relative duration, e.g., 2025-10-23T07:00:00Z, 1d, 30m) [string]Context options: --profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable --org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command --gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` commandFormat options: --output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"] --color Colorize the output [boolean] [default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options: --token Override the authorization token --endpoint Override the API URL --insecure, -k Ignore TLS errors [boolean]Debug options: --verbose, -v Enable verbose output to stderr [boolean] [default: false] --debug, -d Show all HTTP communications [boolean] [default: false]Options: --help Show help [boolean]
Connect to a dev sandbox: its IDE, terminal, or SSHRefer to the dev sandbox guide for additional details.Usage
cpln sandbox connect <ref> [OPTIONS]
This command connects to a dev sandbox. To open a shell in a session of a worker sandbox, use sandbox session connect.
Reference
Positionals: ref The resource reference. Usually it is the name of the resource. [required]Command options: --ide IDE or connection mode to launch. [choices: "vscode", "cursor", "ssh", "browser", "terminal"] [default: "browser"] --local-port Preferred local SSH port. Defaults to an available port chosen automatically. [number] --print-url Print a one-time sign-in link to the browser IDE (or the terminal, with --ide terminal) instead of opening it. The link signs one browser in once and expires in 60 seconds. [boolean]Context options: --profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable --org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command --gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` commandFormat options: --output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"] --color Colorize the output [boolean] [default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options: --token Override the authorization token --endpoint Override the API URL --insecure, -k Ignore TLS errors [boolean]Debug options: --verbose, -v Enable verbose output to stderr [boolean] [default: false] --debug, -d Show all HTTP communications [boolean] [default: false]Options: --help Show help [boolean]
VS Code launched. Press Ctrl+C to stop the port-forward when done. Reconnect anytime with: code --remote ssh-remote+cpln-dev-demo-dev-sandbox.default.demo-cpln-organization /workspace
Open an SSH tunnel to the sandbox and connect from any terminal or IDE
SSH tunnel ready. Connect with "ssh cpln-dev-demo-dev-sandbox.default.demo-cpln-organization", or use "cpln-dev-demo-dev-sandbox.default.demo-cpln-organization" as a Remote-SSH host in your IDE. Press Ctrl+C to stop the port-forward when done.
SSH tunnel ready. Connect with "ssh cpln-dev-demo-dev-sandbox.default.demo-cpln-organization", or use "cpln-dev-demo-dev-sandbox.default.demo-cpln-organization" as a Remote-SSH host in your IDE. Press Ctrl+C to stop the port-forward when done.
sandbox create
Create a new sandboxUsage
cpln sandbox create <ref> [OPTIONS]
--type dev, the default, creates a dev sandbox: an IDE you sign in to. --type worker creates an agent sandbox, which holds the sessions that run commands.
Reference
Positionals: ref The resource reference. Usually it is the name of the resource. [required]Command options: --type Sandbox type: dev (an IDE you sign in to) or worker (holds sessions that run commands). [choices: "dev", "worker"] [default: "dev"] --identity The identity the sandbox runs as: one in the sandbox's GVC. --image The container image the sandbox runs, or //sandboximage/<name> for a ready dev sandbox image of this org, which resolves to its built image. Defaults to the type's standard image. --initial-capacity Home volume capacity in GB, 10 or more. Defaults to the server default. [number] --cpu CPU cores to allocate. Defaults to the server default. --memory, --mem Memory to allocate. Defaults to the server default. --app-port The port the application inside the sandbox listens on, served at the endpoint root. [number] --scale-to-zero-delay Idle seconds (30 to 3600) before the sandbox scales to zero; the next request wakes it. [number] --max-sessions Worker sandboxes only: the sessions one worker sandbox of the identity holds at most. [number] --min-workers Worker sandboxes only: the worker sandboxes kept for the identity, this one included. [number] --max-workers Worker sandboxes only: the worker sandboxes the identity grows to at most, this one included. [number] --idle-delete-delay Worker sandboxes only: seconds a worker sandbox the server added for the identity stays empty before it is deleted. [number] --env Environment variables for the sandbox container (e.g., --env NAME=value).Context options: --profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable --org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command --gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` commandFormat options: --output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"] --color Colorize the output [boolean] [default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options: --token Override the authorization token --endpoint Override the API URL --insecure, -k Ignore TLS errors [boolean]Debug options: --verbose, -v Enable verbose output to stderr [boolean] [default: false] --debug, -d Show all HTTP communications [boolean] [default: false]Options: --help Show help [boolean]
Delete one or more referenced sandboxes and their home volumesUsage
cpln sandbox delete <ref...> [OPTIONS]
Deleting a sandbox also deletes its home volume, and the data on it is lost.
Reference
Positionals: ref One or more resource references. Usually it is the name of the resource. [array] [required] [default: []]Context options: --profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable --org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command --gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` commandFormat options: --output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"] --color Colorize the output [boolean] [default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options: --token Override the authorization token --endpoint Override the API URL --insecure, -k Ignore TLS errors [boolean]Debug options: --verbose, -v Enable verbose output to stderr [boolean] [default: false] --debug, -d Show all HTTP communications [boolean] [default: false]Options: --help Show help [boolean]
If the delete was successful, a new command prompt will be shown.
sandbox edit
Edit the referenced sandbox, as YAML, within an editorUsage
cpln sandbox edit <ref> [OPTIONS]
The default editor can be set by using the EDITOR environment variable.
Reference
Positionals: ref The resource reference. Usually it is the name of the resource. [required]Command options: --replace, -r Replace instead of patch/merge [boolean] [default: false] --dry-run Validate the request and print the resource that would be written, without writing it. Defaults the output format to yaml-slim [boolean]Context options: --profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable --org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command --gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` commandFormat options: --output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"] --color Colorize the output [boolean] [default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options: --token Override the authorization token --endpoint Override the API URL --insecure, -k Ignore TLS errors [boolean]Debug options: --verbose, -v Enable verbose output to stderr [boolean] [default: false] --debug, -d Show all HTTP communications [boolean] [default: false]Options: --help Show help [boolean]
Your default editor will be launched.Once any modifications are saved, the updates will be sent to the API.
sandbox eventlog
Show the event log of the referenced sandboxUsage
cpln sandbox eventlog <ref> [OPTIONS]
Reference
Positionals: ref The resource reference. Usually it is the name of the resource. [required]Context options: --profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable --org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command --gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` commandFormat options: --output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"] --color Colorize the output [boolean] [default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options: --token Override the authorization token --endpoint Override the API URL --insecure, -k Ignore TLS errors [boolean]Debug options: --verbose, -v Enable verbose output to stderr [boolean] [default: false] --debug, -d Show all HTTP communications [boolean] [default: false]Options: --help Show help [boolean]
The event log for the referenced sandbox will be shown.
sandbox get
Retrieve one or more referenced sandboxesUsage
cpln sandbox get [ref...] [OPTIONS]
An empty reference will return all references
Reference
Positionals: ref One or more resource references. Usually it is the name of the resource. [array] [default: []]Command options: --type With no ref: list only the sandboxes of this type. [choices: "dev", "worker"]Context options: --profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable --org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command --gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` commandFormat options: --output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"] --color Colorize the output [boolean] [default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options: --token Override the authorization token --endpoint Override the API URL --insecure, -k Ignore TLS errors [boolean]Debug options: --verbose, -v Enable verbose output to stderr [boolean] [default: false] --debug, -d Show all HTTP communications [boolean] [default: false]Options: --help Show help [boolean]
Running this command with the option --file - sets the input to stdin. The input is required to be a valid JSON or YAML string (e.g., {"description": "My new description"} or description: My new description). To complete the update, press Control-D (or Control-Z if you are using Windows).
Reference
Positionals: ref The resource reference. Usually it is the name of the resource. [required]Command options: --file, -f File to load the patch from. Use `--file -` to enable input from stdin. [required] --dry-run Validate the request and print the resource that would be written, without writing it. Defaults the output format to yaml-slim [boolean]Context options: --profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable --org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command --gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` commandFormat options: --output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"] --color Colorize the output [boolean] [default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options: --token Override the authorization token --endpoint Override the API URL --insecure, -k Ignore TLS errors [boolean]Debug options: --verbose, -v Enable verbose output to stderr [boolean] [default: false] --debug, -d Show all HTTP communications [boolean] [default: false]Options: --help Show help [boolean]
The changes within the JSON file will be performed against the referenced sandbox.
sandbox permissions
Show the grantable permissions for a sandbox object typeUsage
cpln sandbox permissions [OPTIONS]
Reference
Context options: --profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable --org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command --gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` commandFormat options: --output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"] --color Colorize the output [boolean] [default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options: --token Override the authorization token --endpoint Override the API URL --insecure, -k Ignore TLS errors [boolean]Debug options: --verbose, -v Enable verbose output to stderr [boolean] [default: false] --debug, -d Show all HTTP communications [boolean] [default: false]Options: --help Show help [boolean]
+----------------------+-----------------------------------------+-----------------------------------------------------------------------------------------------------------------+|NAME |DESCRIPTION |IMPLIES ||----------------------|-----------------------------------------|-----------------------------------------------------------------------------------------------------------------||configureLoadBalancer |Principal can configure LB | ||connect |Connect to replica (open an interacti... | ||create |Create new workloads | ||delete |Delete existing workloads | ||edit |Modify existing workloads |view ||exec |Execute commands |exec.runCronWorkload, exec.stopReplica ||exec.runCronWorkload |Force a cron-workload to run | ||exec.stopReplica |Force a replica to be stopped | ||manage |Full access |configureLoadBalancer, connect, create, delete, edit, exec, exec.runCronWorkload, exec.stopReplica, manage, view ||view |Read-only access | |+----------------------+-----------------------------------------+-----------------------------------------------------------------------------------------------------------------+
sandbox session
Manage the sessions of a worker sandboxFor a detailed overview, please visit the sandbox sessions’ reference page.
cpln sandbox session [SUBCOMMAND]
Pass --sandbox to name the worker sandbox that holds the session. Leave it out to go through the org’s sandbox GVC, where the session id alone finds its worker sandbox.
Commands: cpln sandbox session connect <session> Open an interactive shell, or run a command in a terminal, in a session of a worker sandbox cpln sandbox session create Create a session on a worker sandbox, or on an identity's worker sandboxes cpln sandbox session delete <session...> Delete one or more sessions of a worker sandbox cpln sandbox session exec <session> Run a command in a session of a worker sandbox cpln sandbox session get [session...] Show one or more sessions, or with no session id, list the sessions of a worker sandbox or of the GVC cpln sandbox session logs <session> Show the log of a session, live or ended cpln sandbox session metrics <session> Show the resource series of a session, live or ended cpln sandbox session preview <session> Open a session's preview on a port in the browser cpln sandbox session processes <session> List the running processes of a session cpln sandbox session signal <session> Send SIGTERM or SIGKILL to a process of a sessionOptions: --help Show help [boolean]
sandbox session connect
Open an interactive shell, or run a command in a terminal, in a session of a worker sandboxUsage
cpln sandbox session connect <session> [OPTIONS]
The shell is bash when the session’s image has it and sh otherwise. To run a single command, use sandbox session exec.
Reference
Positionals: session The session id. [required]Command options: --sandbox The worker sandbox holding the session. Omit it to go through the GVC.Context options: --profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable --org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command --gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` commandFormat options: --output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"] --color Colorize the output [boolean] [default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options: --token Override the authorization token --endpoint Override the API URL --insecure, -k Ignore TLS errors [boolean]Debug options: --verbose, -v Enable verbose output to stderr [boolean] [default: false] --debug, -d Show all HTTP communications [boolean] [default: false]Options: --help Show help [boolean]
Create a session on a worker sandbox, or on an identity’s worker sandboxesUsage
cpln sandbox session create [OPTIONS]
The session token is printed only by this command. Without --sandbox, the server appends -<worker sandbox key> to the session id, so use the id this command returns.
--set firewall... is taken only without --sandbox. The session is placed on a worker sandbox that has exactly those outbound rules, and one is added when none has room. Refer to Lock down egress per session for additional details.
Reference
Command options: --sandbox The worker sandbox to create the session on. Omit it to place the session through the GVC. --identity Instead of --sandbox: place the session on a worker sandbox of this identity (one in the GVC) with room, adding one when none has room. --id The session id, up to 55 characters of letters, digits, dots, underscores, and hyphens. Defaults to one the worker sandbox generates. Through the GVC the server appends -<worker sandbox key>, so use the returned id. --image The OCI image the session runs, or //sandboximage/<name> for a ready agent sandbox image of this org, which resolves to its built image. Defaults to the worker sandbox's own root filesystem. --image-auth Pull a private --image from this org's registry with your own Control Plane token. The token is sent to the worker sandbox that runs the session, so use it only on worker sandboxes you trust. [boolean] --runtime The OCI runtime for the session, e.g., runc or runsc; the worker sandbox refuses one its image does not ship. Defaults to the worker sandbox's default. --env Environment variables for the session (e.g., --env NAME=value). --log Keep every process's output in the session log. [boolean] [default: false] --user The user the session's processes run as. Defaults to the worker sandbox's default user. --memory, --mem The session's memory limit, e.g., 512Mi or 2Gi. Defaults to the worker sandbox's per-session default. --port A port the session serves, for its preview URL (repeatable). [number] --preview Who may open the session's preview URLs: token holders (default) or anyone. [choices: "token", "public"] --wait-timeout Without --sandbox: seconds to wait for a worker sandbox with room, asking again while the server says it is still adding one; 0 returns at once. [number]Session Properties: --set Outbound firewall rules of the worker sandbox the session is placed on; not taken with --sandbox. A list left out allows nothing, so firewall={} blocks all outbound traffic. Each path is set once, with = (e.g., --set firewall.external.outboundAllowHostname=api.example.com,pypi.org). Ports take JSON, e.g., [{"protocol":"tcp","number":443}]: firewall json firewall.external.outboundAllowHostname string[] firewall.external.outboundAllowCIDR string[] firewall.external.outboundBlockedCIDR string[] firewall.external.outboundAllowPort jsonContext options: --profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable --org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command --gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` commandFormat options: --output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"] --color Colorize the output [boolean] [default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options: --token Override the authorization token --endpoint Override the API URL --insecure, -k Ignore TLS errors [boolean]Debug options: --verbose, -v Enable verbose output to stderr [boolean] [default: false] --debug, -d Show all HTTP communications [boolean] [default: false]Options: --help Show help [boolean]
Positionals: session One or more session ids. [array] [required] [default: []]Command options: --sandbox The worker sandbox holding the session. Omit it to go through the GVC.Context options: --profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable --org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command --gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` commandFormat options: --output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"] --color Colorize the output [boolean] [default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options: --token Override the authorization token --endpoint Override the API URL --insecure, -k Ignore TLS errors [boolean]Debug options: --verbose, -v Enable verbose output to stderr [boolean] [default: false] --debug, -d Show all HTTP communications [boolean] [default: false]Options: --help Show help [boolean]
The command’s output streams to your terminal, and its exit code becomes the exit code of the CLI.
Reference
Positionals: session The session id. [required]Command options: --sandbox The worker sandbox holding the session. Omit it to go through the GVC. --stdin, -i Pass this terminal's stdin, or what is piped in, to the command until it ends. [boolean] [default: false]Context options: --profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable --org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command --gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` commandFormat options: --output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"] --color Colorize the output [boolean] [default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options: --token Override the authorization token --endpoint Override the API URL --insecure, -k Ignore TLS errors [boolean]Debug options: --verbose, -v Enable verbose output to stderr [boolean] [default: false] --debug, -d Show all HTTP communications [boolean] [default: false]Options: --help Show help [boolean]
Show one or more sessions, or with no session id, list the sessions of a worker sandbox or of the GVCUsage
cpln sandbox session get [session...] [OPTIONS]
Reference
Positionals: session One or more session ids. [array] [default: []]Command options: --sandbox The worker sandbox holding the session. Omit it to go through the GVC. --identity Without a session id or --sandbox: list only the sessions on the worker sandboxes of this identity. --include-ended Without a session id: list ended sessions as well. Without --sandbox, this asks every worker sandbox live, waking any scaled to zero. [boolean]Context options: --profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable --org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command --gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` commandFormat options: --output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"] --color Colorize the output [boolean] [default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options: --token Override the authorization token --endpoint Override the API URL --insecure, -k Ignore TLS errors [boolean]Debug options: --verbose, -v Enable verbose output to stderr [boolean] [default: false] --debug, -d Show all HTTP communications [boolean] [default: false]Options: --help Show help [boolean]
List the sessions of a worker sandbox, ended ones included
cpln sandbox session get --sandbox demo-worker-sandbox --include-ended --org demo-cpln-organization
List the sessions on the worker sandboxes of an identity
cpln sandbox session get --identity demo-identity --org demo-cpln-organization
Show one session
cpln sandbox session get demo-session --sandbox demo-worker-sandbox --org demo-cpln-organization
sandbox session logs
Show the log of a session, live or endedUsage
cpln sandbox session logs <session> [OPTIONS]
The log always holds the lifecycle lines of the session. The output of its processes is kept only when the session was created with --log.
Reference
Positionals: session The session id. [required]Command options: --sandbox The worker sandbox holding the session. Omit it to go through the GVC. --since Lookback window, e.g., 30m, 1h, 7d. --from Start of the window: an ISO 8601 time or a duration ago, e.g., 2026-10-28T07:00:00Z, 7d. --to End of the window: an ISO 8601 time or a duration ago. --limit Maximum lines to return. [number] --direction Read from the oldest line (forward) or the newest (backward). [choices: "forward", "backward"] --source Only lines from this source: system, stdout, or stderr. --level Only lines at this level or above. --search Only lines containing this text. --follow, -t, -f Keep printing new lines until the session ends. [boolean] [default: false]Context options: --profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable --org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command --gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` commandFormat options: --output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"] --color Colorize the output [boolean] [default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options: --token Override the authorization token --endpoint Override the API URL --insecure, -k Ignore TLS errors [boolean]Debug options: --verbose, -v Enable verbose output to stderr [boolean] [default: false] --debug, -d Show all HTTP communications [boolean] [default: false]Options: --help Show help [boolean]
Show the resource series of a session, live or endedUsage
cpln sandbox session metrics <session> [OPTIONS]
Reference
Positionals: session The session id. [required]Command options: --sandbox The worker sandbox holding the session. Omit it to go through the GVC. --since Lookback window, e.g., 30m, 1h, 7d. --from Start of the window: an ISO 8601 time or a duration ago, e.g., 2026-10-28T07:00:00Z, 7d. --to End of the window: an ISO 8601 time or a duration ago. --points Maximum points to return. [number]Context options: --profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable --org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command --gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` commandFormat options: --output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"] --color Colorize the output [boolean] [default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options: --token Override the authorization token --endpoint Override the API URL --insecure, -k Ignore TLS errors [boolean]Debug options: --verbose, -v Enable verbose output to stderr [boolean] [default: false] --debug, -d Show all HTTP communications [boolean] [default: false]Options: --help Show help [boolean]
Open a session’s preview on a port in the browserUsage
cpln sandbox session preview <session> [OPTIONS]
A link to a token preview opens one browser once and expires shortly. A link to a public preview does not expire.
Reference
Positionals: session The session id. [required]Command options: --sandbox The worker sandbox holding the session. Omit it to go through the GVC. --port The port to open. Defaults to the one port the session declared. [number] --print-url Print the link instead of opening it. A token preview's link opens one browser once and expires shortly; a public preview's link does not expire. [boolean]Context options: --profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable --org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command --gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` commandFormat options: --output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"] --color Colorize the output [boolean] [default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options: --token Override the authorization token --endpoint Override the API URL --insecure, -k Ignore TLS errors [boolean]Debug options: --verbose, -v Enable verbose output to stderr [boolean] [default: false] --debug, -d Show all HTTP communications [boolean] [default: false]Options: --help Show help [boolean]
Positionals: session The session id. [required]Command options: --sandbox The worker sandbox holding the session. Omit it to go through the GVC.Context options: --profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable --org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command --gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` commandFormat options: --output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"] --color Colorize the output [boolean] [default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options: --token Override the authorization token --endpoint Override the API URL --insecure, -k Ignore TLS errors [boolean]Debug options: --verbose, -v Enable verbose output to stderr [boolean] [default: false] --debug, -d Show all HTTP communications [boolean] [default: false]Options: --help Show help [boolean]
Send SIGTERM or SIGKILL to a process of a sessionUsage
cpln sandbox session signal <session> --process PROCESS [OPTIONS]
Reference
Positionals: session The session id. [required]Command options: --sandbox The worker sandbox holding the session. Omit it to go through the GVC. --process The process to signal: its pid, or the tag it was started with. [required] --signal The signal to send. [choices: "SIGTERM", "SIGKILL"] [default: "SIGTERM"]Context options: --profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable --org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command --gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` commandFormat options: --output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"] --color Colorize the output [boolean] [default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options: --token Override the authorization token --endpoint Override the API URL --insecure, -k Ignore TLS errors [boolean]Debug options: --verbose, -v Enable verbose output to stderr [boolean] [default: false] --debug, -d Show all HTTP communications [boolean] [default: false]Options: --help Show help [boolean]
Sent SIGKILL to process app in session demo-session
sandbox start
Start one or more stopped sandboxesUsage
cpln sandbox start <ref...> [OPTIONS]
Reference
Positionals: ref One or more resource references. Usually it is the name of the resource. [array] [required] [default: []]Command options: --dry-run Validate the request and print the resource that would be written, without writing it. Defaults the output format to yaml-slim [boolean]Context options: --profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable --org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command --gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` commandFormat options: --output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"] --color Colorize the output [boolean] [default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options: --token Override the authorization token --endpoint Override the API URL --insecure, -k Ignore TLS errors [boolean]Debug options: --verbose, -v Enable verbose output to stderr [boolean] [default: false] --debug, -d Show all HTTP communications [boolean] [default: false]Options: --help Show help [boolean]
Stop one or more sandboxes until they are started; their home volumes are keptUsage
cpln sandbox stop <ref...> [OPTIONS]
A stopped sandbox keeps its home volume and stays stopped until sandbox start is run. Nothing wakes it in between.
Reference
Positionals: ref One or more resource references. Usually it is the name of the resource. [array] [required] [default: []]Command options: --dry-run Validate the request and print the resource that would be written, without writing it. Defaults the output format to yaml-slim [boolean]Context options: --profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable --org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command --gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` commandFormat options: --output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"] --color Colorize the output [boolean] [default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options: --token Override the authorization token --endpoint Override the API URL --insecure, -k Ignore TLS errors [boolean]Debug options: --verbose, -v Enable verbose output to stderr [boolean] [default: false] --debug, -d Show all HTTP communications [boolean] [default: false]Options: --help Show help [boolean]
Manage the tags belonging to one or more referenced sandboxesUsage
cpln sandbox tag <ref...> --tag KEY=VALUE [OPTIONS]
Built-in tags, which begin with cpln/*, can’t be modified.
Reference
Positionals: ref One or more resource references. Usually it is the name of the resource. [array] [required] [default: []]Command options: --tag Attach tags (e.g., --tag drink=water) --remove-tag Remove tags (e.g., --remove-tag tagname) --dry-run Validate the request and print the resource that would be written, without writing it. Defaults the output format to yaml-slim [boolean]Context options: --profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable --org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command --gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` commandFormat options: --output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"] --color Colorize the output [boolean] [default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options: --token Override the authorization token --endpoint Override the API URL --insecure, -k Ignore TLS errors [boolean]Debug options: --verbose, -v Enable verbose output to stderr [boolean] [default: false] --debug, -d Show all HTTP communications [boolean] [default: false]Options: --help Show help [boolean]
Positionals: ref The resource reference. Usually it is the name of the resource. [required]Update Properties: --set Update the following properties (e.g., --set description="Updated Description"): description string tags.<key> string spec.identityLink string spec.containers.<name>.image string spec.containers.<name>.cpu string spec.containers.<name>.memory string spec.containers.<name>.env.<name>.value string spec.sandbox.appPort number spec.sandbox.scaleToZeroDelay number spec.sandbox.scaling.maxSessions number spec.sandbox.scaling.minWorkers number spec.sandbox.scaling.maxWorkers number spec.sandbox.scaling.idleDeleteDelay number --unset Unset a property (same paths as --set, e.g., --unset description)Command options: --dry-run Validate the request and print the resource that would be written, without writing it. Defaults the output format to yaml-slim [boolean]Context options: --profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable --org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command --gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` commandFormat options: --output, -o Set the output format [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"] --color Colorize the output [boolean] [default: true] --ts Timestamp format if the output format is text (e.g., --output=text) [choices: "iso", "local", "age"] --max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]Request options: --token Override the authorization token --endpoint Override the API URL --insecure, -k Ignore TLS errors [boolean]Debug options: --verbose, -v Enable verbose output to stderr [boolean] [default: false] --debug, -d Show all HTTP communications [boolean] [default: false]Options: --help Show help [boolean]
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Control Plane","description":"Documentation for Control Plane, a hybrid multi-cloud platform for deploying and managing workloads, Kubernetes, networking, secrets, logs, and infrastructure across AWS, GCP, Azure, and private clouds.","colors":{"primary":"#1563ff","light":"#64a5ef","dark":"#1563ff"},"logo":{"light":"https://mintcdn.com/controlplanecorporation/hwvJiAoqIziVJ3gK/logos/dark.svg?fit=max\u0026auto=format\u0026n=hwvJiAoqIziVJ3gK\u0026q=85\u0026s=ec7b5a4bb958adc4d92dedfb41ab2e3c","dark":"https://mintcdn.com/controlplanecorporation/hwvJiAoqIziVJ3gK/logos/light.svg?fit=max\u0026auto=format\u0026n=hwvJiAoqIziVJ3gK\u0026q=85\u0026s=4904ca0b5a8c55fa87495b8edd04aadc"},"favicon":"https://mintcdn.com/controlplanecorporation/hwvJiAoqIziVJ3gK/logos/favicon.png?fit=max\u0026auto=format\u0026n=hwvJiAoqIziVJ3gK\u0026q=85\u0026s=11640a5f7b1a462c233be7a72afa72d7","api":{"openapi":["https://api.cpln.io/openapi.json","https://audit.cpln.io/openapi.json"],"mdx":{"auth":{"method":"bearer"},"server":"https://api.cpln.io"}},"navbar":{"links":[{"href":"https://console.cpln.io/signin","label":"Sign in"}],"primary":{"type":"button","label":"Sign up","href":"https://console.cpln.io/signup"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/control-plane-corporation","youtube":"https://www.youtube.com/@controlplanecorporation","reddit":"https://www.reddit.com/r/controlplane"}},"search":{"prompt":"Search Control Plane docs..."},"seo":{"indexing":"navigable"},"contextual":{"options":["copy","view","chatgpt","claude","perplexity",{"title":"Install MCP Server","description":"Connect the Control Plane MCP Server to your AI tool","icon":"plug","href":"https://docs.controlplane.com/ai/overview"}],"display":"header"},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Website","icon":"compass","href":"https://controlplane.com"},{"anchor":"Status","icon":"signal","href":"https://status.cpln.io/"},{"anchor":"Blog","icon":"newspaper","href":"https://controlplane.com/blog"},{"anchor":"FAQ","icon":"question","href":"https://controlplane.com/faq"},{"anchor":"Product Demos","icon":"video","href":"https://controlplane.com/product-demos"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"controlplanecorporation","hasAudioNarration":false,"actualSubdomain":"controlplanecorporation","customDomains":["docs.controlplane.com"],"gitSource":{"type":"github","owner":"controlplane-docs","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"DISABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"DISABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6b00fd6ef22a3dc383a042f0","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API Reference","count":173},{"language":"default","tag":"Core API","count":164},{"language":"default","tag":"Template Catalog","count":118},{"language":"default","tag":"Templates","count":108},{"language":"default","tag":"Home","count":85},{"language":"default","tag":"How-to Guides","count":71},{"language":"default","tag":"CLI Reference","count":67},{"language":"default","tag":"Reference","count":54},{"language":"default","tag":"Commands","count":39},{"language":"default","tag":"Workload","count":25}],"searchSettings":{"maxResults":5}},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"global.css","content":"html{overflow-y:scroll}"},{"filePath":"style.css","content":"img[src*=\"/icons/mcp-sidebar.svg\"]{filter:brightness(0) saturate(100%) invert(69%) sepia(9%) saturate(309%) hue-rotate(176deg) brightness(95%) contrast(87%)!important}a[aria-current=\"page\"] img[src*=\"/icons/mcp-sidebar.svg\"]{filter:brightness(0) saturate(100%) invert(28%) sepia(98%) saturate(3000%) hue-rotate(213deg) brightness(102%) contrast(101%)!important}.dark img[src*=\"/icons/mcp-sidebar.svg\"]{filter:brightness(0) saturate(100%) invert(47%) sepia(8%) saturate(420%) hue-rotate(177deg) brightness(94%) contrast(85%)!important}.dark a[aria-current=\"page\"] img[src*=\"/icons/mcp-sidebar.svg\"]{filter:brightness(0) saturate(100%) invert(63%) sepia(74%) saturate(380%) hue-rotate(186deg) brightness(98%) contrast(91%)!important}img.sidebar-group-icon[src*=\"/icons/mcp-sidebar.svg\"]{filter:brightness(0)!important}.dark img.sidebar-group-icon[src*=\"/icons/mcp-sidebar.svg\"]{filter:brightness(0) invert(1)!important}img[src*=\"/icons/mcp.svg\"]{filter:brightness(0) saturate(100%) invert(28%) sepia(98%) saturate(3000%) hue-rotate(213deg) brightness(102%) contrast(101%)!important}.dark img[src*=\"/icons/mcp.svg\"]{filter:brightness(0) saturate(100%) invert(63%) sepia(74%) saturate(380%) hue-rotate(186deg) brightness(98%) contrast(91%)!important}.dark img[src*=\"/icons/chatgpt.svg\"],.dark img[src*=\"/icons/codex.svg\"],.dark img[src*=\"/icons/cursor.svg\"],.dark img[src*=\"/icons/opencode.svg\"]{filter:invert(1)!important}"}]}
{"page":{"pagePath":"cli-reference/commands/sandbox","slug":"/cli-reference/commands/sandbox","pageMetadata":{"title":"sandbox","description":"cpln sandbox: Create and manage dev and agent sandboxes, connect to a dev sandbox, and run sessions on an agent sandbox.","keywords":["cpln sandbox","sandbox create","sandbox connect","dev sandbox","agent sandbox","worker sandbox","sandbox session","session exec","cloud ide","sandbox ssh","sandbox vscode","sandbox cursor","code execution","ai agent sandbox","scale to zero"],"href":"/cli-reference/commands/sandbox"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"cpln sandbox: Create and manage dev and agent sandboxes, connect to a dev sandbox, and run sessions on an agent sandbox.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,hr:`hr`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{Accordion,CodeBlock,CodeGroup,Heading,Note,Tip,Warning}=_components;if(!Accordion)_missingMdxReference(`Accordion`,true);if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!CodeGroup)_missingMdxReference(`CodeGroup`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Tip)_missingMdxReference(`Tip`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Manage sandboxes`}),`\n`,_jsxs(_components.p,{children:[`For a detailed overview, please visit the `,_jsx(_components.a,{href:`/reference/sandbox/general`,children:`sandbox’s`}),` reference page.`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`cpln sandbox [SUBCOMMAND]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`The `,_jsx(_components.code,{children:`cpln sandbox`}),` commands find the org’s sandbox GVC themselves, so `,_jsx(_components.code,{children:`--gvc`}),` is not needed. A GVC named by `,_jsx(_components.code,{children:`--gvc`}),`, the `,_jsx(_components.code,{children:`CPLN_GVC`}),` environment variable, or your profile is used as given.`]})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`20`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`20`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Commands:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` cpln sandbox access-report \u003cref> Show the access report for the referenced sandbox`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` cpln sandbox audit \u003cref> Retrieve audit trail events for the referenced sandbox`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` cpln sandbox connect \u003cref> Connect to a dev sandbox: its IDE, terminal, or SSH`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` cpln sandbox create \u003cref> Create a new sandbox`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` cpln sandbox delete \u003cref...> Delete one or more referenced sandboxes and their home volumes`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` cpln sandbox edit \u003cref> Edit the referenced sandbox, as YAML, within an editor`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` cpln sandbox eventlog \u003cref> Show the event log of the referenced sandbox [aliases: log]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` cpln sandbox get [ref...] Retrieve one or more referenced sandboxes`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` cpln sandbox patch \u003cref> Update the referenced sandbox's metadata using an input file`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` cpln sandbox permissions Show the grantable permissions for a sandbox object type`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` cpln sandbox session Manage the sessions of a worker sandbox`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` cpln sandbox start \u003cref...> Start one or more stopped sandboxes`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` cpln sandbox stop \u003cref...> Stop one or more sandboxes until they are started; their home volumes are kept`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` cpln sandbox tag \u003cref...> Manage the tags belonging to one or more referenced sandboxes`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` cpln sandbox update \u003cref> Update properties of the referenced sandbox`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --help Show help [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`4`,id:`sandbox-access-report`,children:`sandbox access-report`}),`\n`,_jsx(_components.p,{children:`Show the access report for the referenced sandbox`}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Usage`})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`cpln sandbox access-report \u003cref> [OPTIONS]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsxs(Accordion,{title:`Reference`,id:`reference`,children:[_jsx(CodeBlock,{filename:``,numberOfLines:`26`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`26`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Positionals:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` ref The resource reference. Usually it is the name of the resource. [required]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Context options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` command\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Format options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --output, -o Set the output format [choices: \"text\", \"json\", \"yaml\", \"json-slim\", \"yaml-slim\", \"tf\", \"crd\", \"names\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --color Colorize the output [boolean] [default: true]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --ts Timestamp format if the output format is text (e.g., --output=text) [choices: \"iso\", \"local\", \"age\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Request options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --token Override the authorization token`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --endpoint Override the API URL`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --insecure, -k Ignore TLS errors [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Debug options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --verbose, -v Enable verbose output to stderr [boolean] [default: false]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --debug, -d Show all HTTP communications [boolean] [default: false]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --help Show help [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),_jsx(_components.p,{children:_jsx(_components.a,{href:`/cli-reference/using-cli/common-options`,children:`Common Options Reference`})})]}),`\n`,_jsx(Accordion,{title:`Example`,id:`example`,children:_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Command`,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`cpln`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` access-report`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-dev-sandbox`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --org`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-cpln-organization`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Output`,numberOfLines:`26`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`26`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`+----------------------+--------------------------------------------------------+--------+`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|PERMISSION |PRINCIPAL |GRANTED |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|----------------------|--------------------------------------------------------|--------|`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|configureLoadBalancer |/org/demo-cpln-organization/group/superusers |manage |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|configureLoadBalancer |/org/demo-cpln-organization/serviceaccount/controlplane |manage |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|connect |/org/demo-cpln-organization/group/superusers |manage |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|connect |/org/demo-cpln-organization/serviceaccount/controlplane |manage |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|create |/org/demo-cpln-organization/group/superusers |manage |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|create |/org/demo-cpln-organization/serviceaccount/controlplane |manage |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|delete |/org/demo-cpln-organization/group/superusers |manage |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|delete |/org/demo-cpln-organization/serviceaccount/controlplane |manage |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|edit |/org/demo-cpln-organization/group/superusers |manage |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|edit |/org/demo-cpln-organization/serviceaccount/controlplane |manage |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|exec |/org/demo-cpln-organization/group/superusers |manage |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|exec |/org/demo-cpln-organization/serviceaccount/controlplane |manage |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|exec.runCronWorkload |/org/demo-cpln-organization/group/superusers |manage |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|exec.runCronWorkload |/org/demo-cpln-organization/serviceaccount/controlplane |manage |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|exec.stopReplica |/org/demo-cpln-organization/group/superusers |manage |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|exec.stopReplica |/org/demo-cpln-organization/serviceaccount/controlplane |manage |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|manage |/org/demo-cpln-organization/group/superusers |manage |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|manage |/org/demo-cpln-organization/serviceaccount/controlplane |manage |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|view |/org/demo-cpln-organization/group/viewers |view |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|view |/org/demo-cpln-organization/group/superusers |manage |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|view |/org/demo-cpln-organization/serviceaccount/controlplane |manage |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`+----------------------+--------------------------------------------------------+--------+`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})})]})}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`4`,id:`sandbox-audit`,children:`sandbox audit`}),`\n`,_jsx(_components.p,{children:`Retrieve audit trail events for the referenced sandbox`}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Usage`})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`cpln sandbox audit \u003cref> [OPTIONS]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsxs(Accordion,{title:`Reference`,id:`reference-1`,children:[_jsx(CodeBlock,{filename:``,numberOfLines:`33`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`33`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Positionals:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` ref The resource reference. Usually it is the name of the resource. [required]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Command options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --subject Filter by subject (serviceaccount name or user email) [string]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --context Audit context name (the 'cpln' context displays Control Plane actions) [string] [default: \"cpln\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --since Relative lookback window from now (e.g., 1h, 24h, 7d). Mutually exclusive with --from/--to [string] [default: \"7d\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --from Start time for audit events (ISO 8601 format or relative duration, e.g., 2025-10-23T07:00:00Z, 7d, 1h). Cannot be used with --since [string]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --to End time for audit events (ISO 8601 format or relative duration, e.g., 2025-10-23T07:00:00Z, 1d, 30m) [string]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Context options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` command\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Format options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --output, -o Set the output format [choices: \"text\", \"json\", \"yaml\", \"json-slim\", \"yaml-slim\", \"tf\", \"crd\", \"names\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --color Colorize the output [boolean] [default: true]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --ts Timestamp format if the output format is text (e.g., --output=text) [choices: \"iso\", \"local\", \"age\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Request options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --token Override the authorization token`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --endpoint Override the API URL`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --insecure, -k Ignore TLS errors [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Debug options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --verbose, -v Enable verbose output to stderr [boolean] [default: false]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --debug, -d Show all HTTP communications [boolean] [default: false]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --help Show help [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),_jsx(_components.p,{children:_jsx(_components.a,{href:`/cli-reference/using-cli/common-options`,children:`Common Options Reference`})})]}),`\n`,_jsxs(Accordion,{title:`Example`,id:`example-1`,children:[_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Show the audit trail events of a sandbox from the last 7 days (the default)`}),`\n`]}),_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`cpln`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` audit`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-dev-sandbox`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --org`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-cpln-organization`})]}),`\n`]})})}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Show the audit trail events of a sandbox from the last 24 hours`}),`\n`]}),_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`cpln`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` audit`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-dev-sandbox`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --since`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 24h`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --org`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-cpln-organization`})]}),`\n`]})})})]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`4`,id:`sandbox-connect`,children:`sandbox connect`}),`\n`,_jsx(_components.p,{children:`Connect to a dev sandbox: its IDE, terminal, or SSH`}),`\n`,_jsxs(_components.p,{children:[`Refer to the `,_jsx(_components.a,{href:`/guides/sandbox/dev-sandbox`,children:`dev sandbox guide`}),` for additional details.`]}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Usage`})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`cpln sandbox connect \u003cref> [OPTIONS]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`This command connects to a dev sandbox. To open a shell in a session of a worker sandbox, use `,_jsx(_components.a,{href:`#sandbox-session-connect`,children:`sandbox session connect`}),`.`]})}),`\n`,_jsxs(Accordion,{title:`Reference`,id:`reference-2`,children:[_jsx(CodeBlock,{filename:``,numberOfLines:`31`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`31`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Positionals:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` ref The resource reference. Usually it is the name of the resource. [required]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Command options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --ide IDE or connection mode to launch. [choices: \"vscode\", \"cursor\", \"ssh\", \"browser\", \"terminal\"] [default: \"browser\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --local-port Preferred local SSH port. Defaults to an available port chosen automatically. [number]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --print-url Print a one-time sign-in link to the browser IDE (or the terminal, with --ide terminal) instead of opening it. The link signs one browser in once and expires in 60 seconds. [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Context options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` command\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Format options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --output, -o Set the output format [choices: \"text\", \"json\", \"yaml\", \"json-slim\", \"yaml-slim\", \"tf\", \"crd\", \"names\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --color Colorize the output [boolean] [default: true]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --ts Timestamp format if the output format is text (e.g., --output=text) [choices: \"iso\", \"local\", \"age\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Request options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --token Override the authorization token`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --endpoint Override the API URL`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --insecure, -k Ignore TLS errors [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Debug options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --verbose, -v Enable verbose output to stderr [boolean] [default: false]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --debug, -d Show all HTTP communications [boolean] [default: false]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --help Show help [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),_jsx(_components.p,{children:_jsx(_components.a,{href:`/cli-reference/using-cli/common-options`,children:`Common Options Reference`})})]}),`\n`,_jsxs(Accordion,{title:`Example`,id:`example-2`,children:[_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Open the browser IDE of a dev sandbox (the default)`}),`\n`]}),_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Command`,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`cpln`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` connect`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-dev-sandbox`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --org`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-cpln-organization`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Output`,numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`If your browser did not open, visit: https://demo-dev-sandbox-4razc9rbmer7r.cpln.app/_ide/ and sign in with your Control Plane account.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})})]}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Open the browser terminal of a dev sandbox`}),`\n`]}),_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Command`,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`cpln`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` connect`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-dev-sandbox`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --ide`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` terminal`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --org`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-cpln-organization`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Output`,numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`If your browser did not open, visit: https://demo-dev-sandbox-4razc9rbmer7r.cpln.app/_term/ and sign in with your Control Plane account.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})})]}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Print a one-time sign-in link instead of opening the browser, for a browser on another machine`}),`\n`]}),_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Command`,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`cpln`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` connect`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-dev-sandbox`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --print-url`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --org`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-cpln-organization`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Output`,numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`https://demo-dev-sandbox-4razc9rbmer7r.cpln.app/_ide/login?redirect=%2F_ide%2F#code=\u003cone-time-code>`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})})]}),_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`Connect with VS Code over SSH (use `,_jsx(_components.code,{children:`--ide cursor`}),` for Cursor)`]}),`\n`]}),_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Command`,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`cpln`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` connect`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-dev-sandbox`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --ide`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` vscode`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --org`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-cpln-organization`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Output`,numberOfLines:`3`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`3`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`VS Code launched. Press Ctrl+C to stop the port-forward when done.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` Reconnect anytime with: code --remote ssh-remote+cpln-dev-demo-dev-sandbox.default.demo-cpln-organization /workspace`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})})]}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Open an SSH tunnel to the sandbox and connect from any terminal or IDE`}),`\n`]}),_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Command`,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`cpln`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` connect`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-dev-sandbox`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --ide`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` ssh`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --org`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-cpln-organization`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Output`,numberOfLines:`3`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`3`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`SSH tunnel ready. Connect with \"ssh cpln-dev-demo-dev-sandbox.default.demo-cpln-organization\", or use \"cpln-dev-demo-dev-sandbox.default.demo-cpln-organization\" as a Remote-SSH host in your IDE.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` Press Ctrl+C to stop the port-forward when done.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})})]}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Open an SSH tunnel using a preferred local port`}),`\n`]}),_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Command`,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`cpln`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` connect`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-dev-sandbox`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --ide`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` ssh`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --local-port`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:` 2222`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --org`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-cpln-organization`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Output`,numberOfLines:`3`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`3`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`SSH tunnel ready. Connect with \"ssh cpln-dev-demo-dev-sandbox.default.demo-cpln-organization\", or use \"cpln-dev-demo-dev-sandbox.default.demo-cpln-organization\" as a Remote-SSH host in your IDE.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` Press Ctrl+C to stop the port-forward when done.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})})]})]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`4`,id:`sandbox-create`,children:`sandbox create`}),`\n`,_jsx(_components.p,{children:`Create a new sandbox`}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Usage`})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`cpln sandbox create \u003cref> [OPTIONS]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`--type dev`}),`, the default, creates a `,_jsx(_components.a,{href:`/guides/sandbox/dev-sandbox`,children:`dev sandbox`}),`: an IDE you sign in to. `,_jsx(_components.code,{children:`--type worker`}),` creates an `,_jsx(_components.a,{href:`/guides/sandbox/agent-sandbox`,children:`agent sandbox`}),`, which holds the `,_jsx(_components.a,{href:`#sandbox-session`,children:`sessions`}),` that run commands.`]})}),`\n`,_jsxs(Accordion,{title:`Reference`,id:`reference-3`,children:[_jsx(CodeBlock,{filename:``,numberOfLines:`41`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`41`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Positionals:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` ref The resource reference. Usually it is the name of the resource. [required]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Command options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --type Sandbox type: dev (an IDE you sign in to) or worker (holds sessions that run commands). [choices: \"dev\", \"worker\"] [default: \"dev\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --identity The identity the sandbox runs as: one in the sandbox's GVC.`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{children:` --image The container image the sandbox runs, or`}),_jsx(_components.span,{children:` //sandboximage/\u003cname> for a ready dev sandbox image of this org, which resolves to its built image. Defaults to the type's standard image.`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --initial-capacity Home volume capacity in GB, 10 or more. Defaults to the server default. [number]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --cpu CPU cores to allocate. Defaults to the server default.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --memory, --mem Memory to allocate. Defaults to the server default.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --app-port The port the application inside the sandbox listens on, served at the endpoint root. [number]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --scale-to-zero-delay Idle seconds (30 to 3600) before the sandbox scales to zero; the next request wakes it. [number]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --max-sessions Worker sandboxes only: the sessions one worker sandbox of the identity holds at most. [number]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --min-workers Worker sandboxes only: the worker sandboxes kept for the identity, this one included. [number]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --max-workers Worker sandboxes only: the worker sandboxes the identity grows to at most, this one included. [number]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --idle-delete-delay Worker sandboxes only: seconds a worker sandbox the server added for the identity stays empty before it is deleted. [number]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --env Environment variables for the sandbox container (e.g., --env NAME=value).`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Context options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` command\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Format options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --output, -o Set the output format [choices: \"text\", \"json\", \"yaml\", \"json-slim\", \"yaml-slim\", \"tf\", \"crd\", \"names\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --color Colorize the output [boolean] [default: true]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --ts Timestamp format if the output format is text (e.g., --output=text) [choices: \"iso\", \"local\", \"age\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Request options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --token Override the authorization token`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --endpoint Override the API URL`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --insecure, -k Ignore TLS errors [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Debug options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --verbose, -v Enable verbose output to stderr [boolean] [default: false]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --debug, -d Show all HTTP communications [boolean] [default: false]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --help Show help [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),_jsx(_components.p,{children:_jsx(_components.a,{href:`/cli-reference/using-cli/common-options`,children:`Common Options Reference`})})]}),`\n`,_jsx(Accordion,{title:`Options`,id:`options`,children:_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`type`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`Choices: `,_jsx(_components.code,{children:`dev`}),`, `,_jsx(_components.code,{children:`worker`})]}),`\n`,_jsxs(_components.li,{children:[`Default: `,_jsx(_components.code,{children:`dev`})]}),`\n`]}),`\n`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`cpu`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Type: string`}),`\n`,_jsxs(_components.li,{children:[`Default: `,_jsx(_components.code,{children:`1000m`}),` for a dev sandbox, `,_jsx(_components.code,{children:`4000m`}),` for a worker sandbox`]}),`\n`]}),`\n`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`memory`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Type: string`}),`\n`,_jsxs(_components.li,{children:[`Default: `,_jsx(_components.code,{children:`2Gi`}),` for a dev sandbox, `,_jsx(_components.code,{children:`8Gi`}),` for a worker sandbox`]}),`\n`]}),`\n`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`initial-capacity`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Type: number (GB)`}),`\n`,_jsx(_components.li,{children:`Default: 20`}),`\n`,_jsx(_components.li,{children:`Minimum Value: 10`}),`\n`,_jsx(_components.li,{children:`Cannot be changed after the sandbox is created`}),`\n`]}),`\n`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`app-port`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Type: number`}),`\n`,_jsx(_components.li,{children:`Default: 8080`}),`\n`,_jsx(_components.li,{children:`Ports 22, 7681, 8443, 8888, 49983, and 49984 are reserved`}),`\n`]}),`\n`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`scale-to-zero-delay`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Type: number (seconds)`}),`\n`,_jsx(_components.li,{children:`Default: 300`}),`\n`,_jsx(_components.li,{children:`Minimum Value: 30`}),`\n`,_jsx(_components.li,{children:`Maximum Value: 3600`}),`\n`]}),`\n`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`max-sessions`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Worker sandboxes only`}),`\n`,_jsx(_components.li,{children:`Type: number`}),`\n`,_jsx(_components.li,{children:`Default: 20`}),`\n`,_jsx(_components.li,{children:`Minimum Value: 1`}),`\n`,_jsx(_components.li,{children:`Maximum Value: 500`}),`\n`]}),`\n`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`min-workers`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Worker sandboxes only`}),`\n`,_jsx(_components.li,{children:`Type: number`}),`\n`,_jsx(_components.li,{children:`Default: 1`}),`\n`,_jsx(_components.li,{children:`Minimum Value: 1`}),`\n`,_jsx(_components.li,{children:`Maximum Value: 100`}),`\n`]}),`\n`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`max-workers`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Worker sandboxes only`}),`\n`,_jsx(_components.li,{children:`Type: number`}),`\n`,_jsx(_components.li,{children:`Default: 10`}),`\n`,_jsx(_components.li,{children:`Minimum Value: 1`}),`\n`,_jsx(_components.li,{children:`Maximum Value: 100`}),`\n`,_jsxs(_components.li,{children:[`Must be at least `,_jsx(_components.code,{children:`min-workers`})]}),`\n`]}),`\n`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`idle-delete-delay`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Worker sandboxes only`}),`\n`,_jsx(_components.li,{children:`Type: number (seconds)`}),`\n`,_jsx(_components.li,{children:`Default: 3600`}),`\n`,_jsx(_components.li,{children:`Minimum Value: 300`}),`\n`,_jsx(_components.li,{children:`Maximum Value: 604800`}),`\n`]}),`\n`]}),`\n`]})}),`\n`,_jsxs(Accordion,{title:`Example`,id:`example-3`,children:[_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Create a dev sandbox`}),`\n`]}),_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Command`,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`cpln`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` create`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-dev-sandbox`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --org`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-cpln-organization`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Output`,numberOfLines:`9`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`9`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`+-----------------+-----------------+--------+------+--------+------------------------------------------------+------------------------+`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|NAME |DESCRIPTION |GVC |READY |CREATED |ENDPOINT |TAGS |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|-----------------|-----------------|--------|------|--------|------------------------------------------------|------------------------|`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|demo-dev-sandbox |demo-dev-sandbox |default | |Now |https://demo-dev-sandbox-4razc9rbmer7r.cpln.app |cpln/dev-type=\"devbox\" |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`| | | | | | |cpln/kata=\"true\" |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`| | | | | | |cpln/sandbox=\"true\" |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`| | | | | | |cpln/scaleToZero=\"true\" |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`+-----------------+-----------------+--------+------+--------+------------------------------------------------+------------------------+`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})})]}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Create a worker sandbox sized for the sessions it holds`}),`\n`]}),_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Command`,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`cpln`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` create`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-worker-sandbox`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --type`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` worker`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --cpu`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 2000m`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --memory`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 4Gi`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --max-sessions`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:` 10`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --org`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-cpln-organization`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Output`,numberOfLines:`10`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`10`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`+--------------------+--------------------+--------+------+--------+---------------------------------------------------+-------------------------------------------+`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|NAME |DESCRIPTION |GVC |READY |CREATED |ENDPOINT |TAGS |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|--------------------|--------------------|--------|------|--------|---------------------------------------------------|-------------------------------------------|`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|demo-worker-sandbox |demo-worker-sandbox |default | |Now |https://demo-worker-sandbox-4razc9rbmer7r.cpln.app |cpln/disableServiceMeshInboundPort=\"49984\" |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`| | | | | | |cpln/kata=\"true\" |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`| | | | | | |cpln/kataPrivileged=\"true\" |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`| | | | | | |cpln/sandbox=\"true\" |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`| | | | | | |cpln/scaleToZero=\"true\" |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`+--------------------+--------------------+--------+------+--------+---------------------------------------------------+-------------------------------------------+`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})})]}),_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`Create a dev sandbox that runs a ready `,_jsx(_components.a,{href:`/cli-reference/commands/sandboximage`,children:`sandbox image`})]}),`\n`]}),_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`cpln`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` create`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-dev-sandbox`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --image`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` //sandboximage/demo-sandbox-image`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --org`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-cpln-organization`})]}),`\n`]})})}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Create the first worker sandbox of an identity and set how the identity’s worker sandboxes scale`}),`\n`]}),_jsx(CodeBlock,{filename:``,numberOfLines:`3`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`3`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`cpln`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` create`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-worker-sandbox`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --type`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` worker`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --identity`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-identity`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --max-sessions`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:` 20`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --min-workers`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:` 1`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --max-workers`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:` 5`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --idle-delete-delay`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:` 3600`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --org`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-cpln-organization`})]}),`\n`]})})})]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`4`,id:`sandbox-delete`,children:`sandbox delete`}),`\n`,_jsx(_components.p,{children:`Delete one or more referenced sandboxes and their home volumes`}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Usage`})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`cpln sandbox delete \u003cref...> [OPTIONS]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`Deleting a sandbox also deletes its home volume, and the data on it is lost.`})}),`\n`,_jsxs(Accordion,{title:`Reference`,id:`reference-4`,children:[_jsx(CodeBlock,{filename:``,numberOfLines:`26`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`26`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Positionals:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` ref One or more resource references. Usually it is the name of the resource. [array] [required] [default: []]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Context options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` command\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Format options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --output, -o Set the output format [choices: \"text\", \"json\", \"yaml\", \"json-slim\", \"yaml-slim\", \"tf\", \"crd\", \"names\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --color Colorize the output [boolean] [default: true]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --ts Timestamp format if the output format is text (e.g., --output=text) [choices: \"iso\", \"local\", \"age\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Request options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --token Override the authorization token`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --endpoint Override the API URL`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --insecure, -k Ignore TLS errors [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Debug options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --verbose, -v Enable verbose output to stderr [boolean] [default: false]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --debug, -d Show all HTTP communications [boolean] [default: false]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --help Show help [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),_jsx(_components.p,{children:_jsx(_components.a,{href:`/cli-reference/using-cli/common-options`,children:`Common Options Reference`})})]}),`\n`,_jsx(Accordion,{title:`Example`,id:`example-4`,children:_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Command`,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`cpln`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` delete`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-dev-sandbox`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --org`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-cpln-organization`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Output`,numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`If the delete was successful, a new command prompt will be shown.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})})]})}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`4`,id:`sandbox-edit`,children:`sandbox edit`}),`\n`,_jsx(_components.p,{children:`Edit the referenced sandbox, as YAML, within an editor`}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Usage`})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`cpln sandbox edit \u003cref> [OPTIONS]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(Note,{children:_jsx(_components.p,{children:`The default editor can be set by using the EDITOR environment variable.`})}),`\n`,_jsxs(Accordion,{title:`Reference`,id:`reference-5`,children:[_jsx(CodeBlock,{filename:``,numberOfLines:`30`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`30`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Positionals:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` ref The resource reference. Usually it is the name of the resource. [required]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Command options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --replace, -r Replace instead of patch/merge [boolean] [default: false]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --dry-run Validate the request and print the resource that would be written, without writing it. Defaults the output format to yaml-slim [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Context options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` command\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Format options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --output, -o Set the output format [choices: \"text\", \"json\", \"yaml\", \"json-slim\", \"yaml-slim\", \"tf\", \"crd\", \"names\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --color Colorize the output [boolean] [default: true]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --ts Timestamp format if the output format is text (e.g., --output=text) [choices: \"iso\", \"local\", \"age\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Request options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --token Override the authorization token`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --endpoint Override the API URL`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --insecure, -k Ignore TLS errors [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Debug options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --verbose, -v Enable verbose output to stderr [boolean] [default: false]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --debug, -d Show all HTTP communications [boolean] [default: false]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --help Show help [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),_jsx(_components.p,{children:_jsx(_components.a,{href:`/cli-reference/using-cli/common-options`,children:`Common Options Reference`})})]}),`\n`,_jsx(Accordion,{title:`Example`,id:`example-5`,children:_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Command`,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`cpln`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` edit`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-dev-sandbox`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --org`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-cpln-organization`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Output`,numberOfLines:`4`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`4`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Your default editor will be launched.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Once any modifications are saved, the updates will be sent to the API.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})})]})}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`4`,id:`sandbox-eventlog`,children:`sandbox eventlog`}),`\n`,_jsx(_components.p,{children:`Show the event log of the referenced sandbox`}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Usage`})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`cpln sandbox eventlog \u003cref> [OPTIONS]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsxs(Accordion,{title:`Reference`,id:`reference-6`,children:[_jsx(CodeBlock,{filename:``,numberOfLines:`26`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`26`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Positionals:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` ref The resource reference. Usually it is the name of the resource. [required]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Context options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` command\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Format options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --output, -o Set the output format [choices: \"text\", \"json\", \"yaml\", \"json-slim\", \"yaml-slim\", \"tf\", \"crd\", \"names\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --color Colorize the output [boolean] [default: true]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --ts Timestamp format if the output format is text (e.g., --output=text) [choices: \"iso\", \"local\", \"age\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Request options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --token Override the authorization token`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --endpoint Override the API URL`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --insecure, -k Ignore TLS errors [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Debug options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --verbose, -v Enable verbose output to stderr [boolean] [default: false]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --debug, -d Show all HTTP communications [boolean] [default: false]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --help Show help [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),_jsx(_components.p,{children:_jsx(_components.a,{href:`/cli-reference/using-cli/common-options`,children:`Common Options Reference`})})]}),`\n`,_jsx(Accordion,{title:`Example`,id:`example-6`,children:_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Command`,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`cpln`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` eventlog`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-dev-sandbox`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --org`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-cpln-organization`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Output`,numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`The event log for the referenced sandbox will be shown.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})})]})}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`4`,id:`sandbox-get`,children:`sandbox get`}),`\n`,_jsx(_components.p,{children:`Retrieve one or more referenced sandboxes`}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Usage`})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`cpln sandbox get [ref...] [OPTIONS]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(Note,{children:_jsx(_components.p,{children:`An empty reference will return all references`})}),`\n`,_jsxs(Accordion,{title:`Reference`,id:`reference-7`,children:[_jsx(CodeBlock,{filename:``,numberOfLines:`29`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`29`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Positionals:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` ref One or more resource references. Usually it is the name of the resource. [array] [default: []]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Command options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --type With no ref: list only the sandboxes of this type. [choices: \"dev\", \"worker\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Context options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` command\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Format options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --output, -o Set the output format [choices: \"text\", \"json\", \"yaml\", \"json-slim\", \"yaml-slim\", \"tf\", \"crd\", \"names\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --color Colorize the output [boolean] [default: true]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --ts Timestamp format if the output format is text (e.g., --output=text) [choices: \"iso\", \"local\", \"age\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Request options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --token Override the authorization token`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --endpoint Override the API URL`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --insecure, -k Ignore TLS errors [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Debug options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --verbose, -v Enable verbose output to stderr [boolean] [default: false]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --debug, -d Show all HTTP communications [boolean] [default: false]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --help Show help [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),_jsx(_components.p,{children:_jsx(_components.a,{href:`/cli-reference/using-cli/common-options`,children:`Common Options Reference`})})]}),`\n`,_jsxs(Accordion,{title:`Example`,id:`example-7`,children:[_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Get all sandboxes`}),`\n`]}),_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Command`,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`cpln`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` get`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --org`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-cpln-organization`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Output`,numberOfLines:`14`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`14`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`+--------------------+--------------------+--------+------+---------------+---------------------------------------------------+-------------------------------------------+`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|NAME |DESCRIPTION |GVC |READY |CREATED |ENDPOINT |TAGS |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|--------------------|--------------------|--------|------|---------------|---------------------------------------------------|-------------------------------------------|`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|demo-dev-sandbox |demo-dev-sandbox |default |true |12 minutes ago |https://demo-dev-sandbox-4razc9rbmer7r.cpln.app |cpln/dev-type=\"devbox\" |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`| | | | | | |cpln/kata=\"true\" |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`| | | | | | |cpln/sandbox=\"true\" |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`| | | | | | |cpln/scaleToZero=\"true\" |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|demo-worker-sandbox |demo-worker-sandbox |default |true |7 minutes ago |https://demo-worker-sandbox-4razc9rbmer7r.cpln.app |cpln/disableServiceMeshInboundPort=\"49984\" |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`| | | | | | |cpln/kata=\"true\" |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`| | | | | | |cpln/kataPrivileged=\"true\" |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`| | | | | | |cpln/sandbox=\"true\" |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`| | | | | | |cpln/scaleToZero=\"true\" |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`+--------------------+--------------------+--------+------+---------------+---------------------------------------------------+-------------------------------------------+`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})})]}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Get only the worker sandboxes`}),`\n`]}),_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Command`,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`cpln`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` get`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --type`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` worker`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --org`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-cpln-organization`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Output`,numberOfLines:`10`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`10`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`+--------------------+--------------------+--------+------+--------------+---------------------------------------------------+-------------------------------------------+`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|NAME |DESCRIPTION |GVC |READY |CREATED |ENDPOINT |TAGS |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|--------------------|--------------------|--------|------|--------------|---------------------------------------------------|-------------------------------------------|`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|demo-worker-sandbox |demo-worker-sandbox |default |true |7 minutes ago |https://demo-worker-sandbox-4razc9rbmer7r.cpln.app |cpln/disableServiceMeshInboundPort=\"49984\" |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`| | | | | | |cpln/kata=\"true\" |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`| | | | | | |cpln/kataPrivileged=\"true\" |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`| | | | | | |cpln/sandbox=\"true\" |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`| | | | | | |cpln/scaleToZero=\"true\" |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`+--------------------+--------------------+--------+------+--------------+---------------------------------------------------+-------------------------------------------+`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})})]}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Get one sandbox`}),`\n`]}),_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Command`,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`cpln`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` get`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-dev-sandbox`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --org`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-cpln-organization`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Output`,numberOfLines:`9`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`9`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`+-----------------+-----------------+--------+------+---------------+------------------------------------------------+------------------------+`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|NAME |DESCRIPTION |GVC |READY |CREATED |ENDPOINT |TAGS |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|-----------------|-----------------|--------|------|---------------|------------------------------------------------|------------------------|`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|demo-dev-sandbox |demo-dev-sandbox |default |true |12 minutes ago |https://demo-dev-sandbox-4razc9rbmer7r.cpln.app |cpln/dev-type=\"devbox\" |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`| | | | | | |cpln/kata=\"true\" |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`| | | | | | |cpln/sandbox=\"true\" |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`| | | | | | |cpln/scaleToZero=\"true\" |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`+-----------------+-----------------+--------+------+---------------+------------------------------------------------+------------------------+`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})})]})]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`4`,id:`sandbox-patch`,children:`sandbox patch`}),`\n`,_jsx(_components.p,{children:`Update the referenced sandbox’s metadata using an input file`}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Usage`})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`cpln sandbox patch \u003cref> --file FILE_NAME [OPTIONS]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`Running this command with the option `,_jsx(_components.strong,{children:_jsx(_components.code,{children:`--file -`})}),` sets the input to stdin. The input is required to be a valid JSON or YAML string (e.g., `,_jsx(_components.code,{children:`{\"description\": \"My new description\"}`}),` or `,_jsx(_components.code,{children:`description: My new description`}),`). To complete the update, press Control-D (or Control-Z if you are using Windows).`]})}),`\n`,_jsxs(Accordion,{title:`Reference`,id:`reference-8`,children:[_jsx(CodeBlock,{filename:``,numberOfLines:`30`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`30`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Positionals:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` ref The resource reference. Usually it is the name of the resource. [required]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Command options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --file, -f File to load the patch from. Use `--file -` to enable input from stdin. [required]\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --dry-run Validate the request and print the resource that would be written, without writing it. Defaults the output format to yaml-slim [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Context options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` command\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Format options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --output, -o Set the output format [choices: \"text\", \"json\", \"yaml\", \"json-slim\", \"yaml-slim\", \"tf\", \"crd\", \"names\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --color Colorize the output [boolean] [default: true]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --ts Timestamp format if the output format is text (e.g., --output=text) [choices: \"iso\", \"local\", \"age\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Request options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --token Override the authorization token`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --endpoint Override the API URL`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --insecure, -k Ignore TLS errors [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Debug options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --verbose, -v Enable verbose output to stderr [boolean] [default: false]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --debug, -d Show all HTTP communications [boolean] [default: false]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --help Show help [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),_jsx(_components.p,{children:_jsx(_components.a,{href:`/cli-reference/using-cli/common-options`,children:`Common Options Reference`})})]}),`\n`,_jsx(Accordion,{title:`Example`,id:`example-8`,children:_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Command`,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`cpln`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` patch`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-dev-sandbox`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --file`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` update.json`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --org`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-cpln-organization`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Output`,numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`The changes within the JSON file will be performed against the referenced sandbox.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})})]})}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`4`,id:`sandbox-permissions`,children:`sandbox permissions`}),`\n`,_jsx(_components.p,{children:`Show the grantable permissions for a sandbox object type`}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Usage`})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`cpln sandbox permissions [OPTIONS]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsxs(Accordion,{title:`Reference`,id:`reference-9`,children:[_jsx(CodeBlock,{filename:``,numberOfLines:`23`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`23`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Context options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` command\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Format options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --output, -o Set the output format [choices: \"text\", \"json\", \"yaml\", \"json-slim\", \"yaml-slim\", \"tf\", \"crd\", \"names\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --color Colorize the output [boolean] [default: true]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --ts Timestamp format if the output format is text (e.g., --output=text) [choices: \"iso\", \"local\", \"age\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Request options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --token Override the authorization token`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --endpoint Override the API URL`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --insecure, -k Ignore TLS errors [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Debug options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --verbose, -v Enable verbose output to stderr [boolean] [default: false]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --debug, -d Show all HTTP communications [boolean] [default: false]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --help Show help [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),_jsx(_components.p,{children:_jsx(_components.a,{href:`/cli-reference/using-cli/common-options`,children:`Common Options Reference`})})]}),`\n`,_jsx(Accordion,{title:`Example`,id:`example-9`,children:_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Command`,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`cpln`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` permissions`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --org`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-cpln-organization`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Output`,numberOfLines:`15`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`15`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`+----------------------+-----------------------------------------+-----------------------------------------------------------------------------------------------------------------+`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|NAME |DESCRIPTION |IMPLIES |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|----------------------|-----------------------------------------|-----------------------------------------------------------------------------------------------------------------|`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|configureLoadBalancer |Principal can configure LB | |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|connect |Connect to replica (open an interacti... | |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|create |Create new workloads | |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|delete |Delete existing workloads | |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|edit |Modify existing workloads |view |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|exec |Execute commands |exec.runCronWorkload, exec.stopReplica |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|exec.runCronWorkload |Force a cron-workload to run | |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|exec.stopReplica |Force a replica to be stopped | |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|manage |Full access |configureLoadBalancer, connect, create, delete, edit, exec, exec.runCronWorkload, exec.stopReplica, manage, view |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|view |Read-only access | |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`+----------------------+-----------------------------------------+-----------------------------------------------------------------------------------------------------------------+`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})})]})}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`4`,id:`sandbox-session`,children:`sandbox session`}),`\n`,_jsx(_components.p,{children:`Manage the sessions of a worker sandbox`}),`\n`,_jsxs(_components.p,{children:[`For a detailed overview, please visit the `,_jsx(_components.a,{href:`/reference/sandbox/sessions`,children:`sandbox sessions’`}),` reference page.`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`cpln sandbox session [SUBCOMMAND]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`Pass `,_jsx(_components.code,{children:`--sandbox`}),` to name the worker sandbox that holds the session. Leave it out to go through the org’s sandbox GVC, where the session id alone finds its worker sandbox.`]})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`15`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`15`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Commands:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` cpln sandbox session connect \u003csession> Open an interactive shell, or run a command in a terminal, in a session of a worker sandbox`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` cpln sandbox session create Create a session on a worker sandbox, or on an identity's worker sandboxes`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` cpln sandbox session delete \u003csession...> Delete one or more sessions of a worker sandbox`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` cpln sandbox session exec \u003csession> Run a command in a session of a worker sandbox`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` cpln sandbox session get [session...] Show one or more sessions, or with no session id, list the sessions of a worker sandbox or of the GVC`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` cpln sandbox session logs \u003csession> Show the log of a session, live or ended`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` cpln sandbox session metrics \u003csession> Show the resource series of a session, live or ended`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` cpln sandbox session preview \u003csession> Open a session's preview on a port in the browser`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` cpln sandbox session processes \u003csession> List the running processes of a session`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` cpln sandbox session signal \u003csession> Send SIGTERM or SIGKILL to a process of a session`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --help Show help [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(Heading,{level:`4`,id:`sandbox-session-connect`,children:`sandbox session connect`}),`\n`,_jsx(_components.p,{children:`Open an interactive shell, or run a command in a terminal, in a session of a worker sandbox`}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Usage`})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`cpln sandbox session connect \u003csession> [OPTIONS]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`The shell is `,_jsx(_components.code,{children:`bash`}),` when the session’s image has it and `,_jsx(_components.code,{children:`sh`}),` otherwise. To run a single command, use `,_jsx(_components.a,{href:`#sandbox-session-exec`,children:`sandbox session exec`}),`.`]})}),`\n`,_jsxs(Accordion,{title:`Reference`,id:`reference-10`,children:[_jsx(CodeBlock,{filename:``,numberOfLines:`29`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`29`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Positionals:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` session The session id. [required]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Command options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --sandbox The worker sandbox holding the session. Omit it to go through the GVC.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Context options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` command\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Format options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --output, -o Set the output format [choices: \"text\", \"json\", \"yaml\", \"json-slim\", \"yaml-slim\", \"tf\", \"crd\", \"names\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --color Colorize the output [boolean] [default: true]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --ts Timestamp format if the output format is text (e.g., --output=text) [choices: \"iso\", \"local\", \"age\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Request options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --token Override the authorization token`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --endpoint Override the API URL`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --insecure, -k Ignore TLS errors [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Debug options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --verbose, -v Enable verbose output to stderr [boolean] [default: false]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --debug, -d Show all HTTP communications [boolean] [default: false]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --help Show help [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),_jsx(_components.p,{children:_jsx(_components.a,{href:`/cli-reference/using-cli/common-options`,children:`Common Options Reference`})})]}),`\n`,_jsx(Accordion,{title:`Example`,id:`example-10`,children:_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`cpln`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` session`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` connect`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-session`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-worker-sandbox`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --org`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-cpln-organization`})]}),`\n`]})})})}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`4`,id:`sandbox-session-create`,children:`sandbox session create`}),`\n`,_jsx(_components.p,{children:`Create a session on a worker sandbox, or on an identity’s worker sandboxes`}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Usage`})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`cpln sandbox session create [OPTIONS]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`The session token is printed only by this command. Without `,_jsx(_components.code,{children:`--sandbox`}),`, the server appends `,_jsx(_components.code,{children:`-\u003cworker sandbox key>`}),` to the session id, so use the `,_jsx(_components.code,{children:`id`}),` this command returns.`]})}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`--set firewall...`}),` is taken only without `,_jsx(_components.code,{children:`--sandbox`}),`. The session is placed on a worker sandbox that has exactly those outbound rules, and one is added when none has room. Refer to `,_jsx(_components.a,{href:`/guides/sandbox/agent-sandbox#lock-down-egress-per-session`,children:`Lock down egress per session`}),` for additional details.`]})}),`\n`,_jsxs(Accordion,{title:`Reference`,id:`reference-11`,children:[_jsx(CodeBlock,{filename:``,numberOfLines:`47`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`47`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Command options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --sandbox The worker sandbox to create the session on. Omit it to place the session through the GVC.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --identity Instead of --sandbox: place the session on a worker sandbox of this identity (one in the GVC) with room, adding one when none has room.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --id The session id, up to 55 characters of letters, digits, dots, underscores, and hyphens. Defaults to one the worker sandbox generates. Through the GVC the server appends -\u003cworker sandbox key>, so use the returned id.`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{children:` --image The OCI image the session runs, or`}),_jsx(_components.span,{children:` //sandboximage/\u003cname> for a ready agent sandbox image of this org, which resolves to its built image. Defaults to the worker sandbox's own root filesystem.`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --image-auth Pull a private --image from this org's registry with your own Control Plane token. The token is sent to the worker sandbox that runs the session, so use it only on worker sandboxes you trust. [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --runtime The OCI runtime for the session, e.g., runc or runsc; the worker sandbox refuses one its image does not ship. Defaults to the worker sandbox's default.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --env Environment variables for the session (e.g., --env NAME=value).`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --log Keep every process's output in the session log. [boolean] [default: false]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --user The user the session's processes run as. Defaults to the worker sandbox's default user.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --memory, --mem The session's memory limit, e.g., 512Mi or 2Gi. Defaults to the worker sandbox's per-session default.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --port A port the session serves, for its preview URL (repeatable). [number]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --preview Who may open the session's preview URLs: token holders (default) or anyone. [choices: \"token\", \"public\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --wait-timeout Without --sandbox: seconds to wait for a worker sandbox with room, asking again while the server says it is still adding one; 0 returns at once. [number]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Session Properties:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --set Outbound firewall rules of the worker sandbox the session is placed on; not taken with --sandbox. A list left out allows nothing, so firewall={} blocks all outbound traffic. Each path is set once, with = (e.g., --set firewall.external.outboundAllowHostname=api.example.com,pypi.org). Ports take JSON, e.g., [{\"protocol\":\"tcp\",\"number\":443}]:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` firewall json`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` firewall.external.outboundAllowHostname string[]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` firewall.external.outboundAllowCIDR string[]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` firewall.external.outboundBlockedCIDR string[]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` firewall.external.outboundAllowPort json`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Context options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` command\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Format options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --output, -o Set the output format [choices: \"text\", \"json\", \"yaml\", \"json-slim\", \"yaml-slim\", \"tf\", \"crd\", \"names\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --color Colorize the output [boolean] [default: true]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --ts Timestamp format if the output format is text (e.g., --output=text) [choices: \"iso\", \"local\", \"age\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Request options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --token Override the authorization token`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --endpoint Override the API URL`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --insecure, -k Ignore TLS errors [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Debug options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --verbose, -v Enable verbose output to stderr [boolean] [default: false]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --debug, -d Show all HTTP communications [boolean] [default: false]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --help Show help [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),_jsx(_components.p,{children:_jsx(_components.a,{href:`/cli-reference/using-cli/common-options`,children:`Common Options Reference`})})]}),`\n`,_jsxs(Accordion,{title:`Example`,id:`example-11`,children:[_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Create a session on a worker sandbox, running a public image`}),`\n`]}),_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Command`,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`cpln`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` session`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` create`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-worker-sandbox`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --id`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-session`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --image`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` python:3.12-slim`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --org`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-cpln-organization`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Output`,numberOfLines:`21`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`21`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`{`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"id\": \"demo-session\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"token\": \"\u003csession-token>\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"workspace\": \"/var/lib/devboxd/sessions/demo-session/workspace\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"isolation\": \"container\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"runtime\": \"runc\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"mechanism\": \"empty\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"image\": \"python:3.12-slim\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"imageDigest\": \"sha256:\u003cdigest>\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"network\": \"netns\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"ip\": \"10.200.0.2\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"preview\": {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"mode\": \"token\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"base\": \"https://demo-worker-sandbox-4razc9rbmer7r.cpln.app/_s/demo-session/\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"urls\": {}`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"logOutput\": false,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"worker\": \"demo-worker-sandbox\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"endpoint\": \"https://demo-worker-sandbox-4razc9rbmer7r.cpln.app\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`}`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})})]}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Create a session on one of an identity’s worker sandboxes with room, adding one when none has room`}),`\n`]}),_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`cpln`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` session`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` create`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --identity`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-identity`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --id`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-session`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --org`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-cpln-organization`})]}),`\n`]})})}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Create a session that serves port 3000, has a 1Gi memory limit, and keeps the output of every process in its log`}),`\n`]}),_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`cpln`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` session`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` create`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-worker-sandbox`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --id`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-session`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --port`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:` 3000`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --memory`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 1Gi`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --log`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --org`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-cpln-organization`})]}),`\n`]})})}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Create a session that may only reach the listed hostnames`}),`\n`]}),_jsx(CodeBlock,{filename:``,numberOfLines:`3`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`3`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`cpln`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` session`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` create`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --identity`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-identity`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --id`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-session`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --set`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` firewall.external.outboundAllowHostname=api.github.com,pypi.org`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --org`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-cpln-organization`})]}),`\n`]})})}),_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`Create a session that runs a ready agent `,_jsx(_components.a,{href:`/cli-reference/commands/sandboximage`,children:`sandbox image`})]}),`\n`]}),_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`cpln`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` session`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` create`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-worker-sandbox`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --id`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-session`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --image`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` //sandboximage/demo-agent-image`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --org`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-cpln-organization`})]}),`\n`]})})})]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`4`,id:`sandbox-session-delete`,children:`sandbox session delete`}),`\n`,_jsx(_components.p,{children:`Delete one or more sessions of a worker sandbox`}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Usage`})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`cpln sandbox session delete \u003csession...> [OPTIONS]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsxs(Accordion,{title:`Reference`,id:`reference-12`,children:[_jsx(CodeBlock,{filename:``,numberOfLines:`29`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`29`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Positionals:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` session One or more session ids. [array] [required] [default: []]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Command options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --sandbox The worker sandbox holding the session. Omit it to go through the GVC.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Context options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` command\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Format options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --output, -o Set the output format [choices: \"text\", \"json\", \"yaml\", \"json-slim\", \"yaml-slim\", \"tf\", \"crd\", \"names\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --color Colorize the output [boolean] [default: true]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --ts Timestamp format if the output format is text (e.g., --output=text) [choices: \"iso\", \"local\", \"age\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Request options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --token Override the authorization token`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --endpoint Override the API URL`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --insecure, -k Ignore TLS errors [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Debug options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --verbose, -v Enable verbose output to stderr [boolean] [default: false]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --debug, -d Show all HTTP communications [boolean] [default: false]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --help Show help [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),_jsx(_components.p,{children:_jsx(_components.a,{href:`/cli-reference/using-cli/common-options`,children:`Common Options Reference`})})]}),`\n`,_jsx(Accordion,{title:`Example`,id:`example-12`,children:_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Command`,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`cpln`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` session`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` delete`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-session`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-worker-sandbox`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --org`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-cpln-organization`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Output`,numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`If the delete was successful, a new command prompt will be shown.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})})]})}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`4`,id:`sandbox-session-exec`,children:`sandbox session exec`}),`\n`,_jsx(_components.p,{children:`Run a command in a session of a worker sandbox`}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Usage`})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`cpln sandbox session exec \u003csession> [OPTIONS] -- COMMAND ARG1 ARG2`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(Note,{children:_jsx(_components.p,{children:`The command’s output streams to your terminal, and its exit code becomes the exit code of the CLI.`})}),`\n`,_jsxs(Accordion,{title:`Reference`,id:`reference-13`,children:[_jsx(CodeBlock,{filename:``,numberOfLines:`30`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`30`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Positionals:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` session The session id. [required]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Command options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --sandbox The worker sandbox holding the session. Omit it to go through the GVC.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --stdin, -i Pass this terminal's stdin, or what is piped in, to the command until it ends. [boolean] [default: false]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Context options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` command\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Format options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --output, -o Set the output format [choices: \"text\", \"json\", \"yaml\", \"json-slim\", \"yaml-slim\", \"tf\", \"crd\", \"names\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --color Colorize the output [boolean] [default: true]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --ts Timestamp format if the output format is text (e.g., --output=text) [choices: \"iso\", \"local\", \"age\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Request options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --token Override the authorization token`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --endpoint Override the API URL`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --insecure, -k Ignore TLS errors [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Debug options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --verbose, -v Enable verbose output to stderr [boolean] [default: false]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --debug, -d Show all HTTP communications [boolean] [default: false]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --help Show help [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),_jsx(_components.p,{children:_jsx(_components.a,{href:`/cli-reference/using-cli/common-options`,children:`Common Options Reference`})})]}),`\n`,_jsxs(Accordion,{title:`Example`,id:`example-13`,children:[_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Run a command in a session`}),`\n`]}),_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Command`,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`cpln`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` session`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` exec`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-session`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-worker-sandbox`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --org`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-cpln-organization`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` python3`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -c`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'print(42)'`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Output`,numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`42`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})})]}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Pipe a script into a command in a session`}),`\n`]}),_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Command`,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:`echo`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'print(42)'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` |`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:` cpln`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` session`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` exec`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-session`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-worker-sandbox`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --stdin`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --org`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-cpln-organization`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` python3`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` -`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Output`,numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`42`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})})]})]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`4`,id:`sandbox-session-get`,children:`sandbox session get`}),`\n`,_jsx(_components.p,{children:`Show one or more sessions, or with no session id, list the sessions of a worker sandbox or of the GVC`}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Usage`})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`cpln sandbox session get [session...] [OPTIONS]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsxs(Accordion,{title:`Reference`,id:`reference-14`,children:[_jsx(CodeBlock,{filename:``,numberOfLines:`31`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`31`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Positionals:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` session One or more session ids. [array] [default: []]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Command options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --sandbox The worker sandbox holding the session. Omit it to go through the GVC.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --identity Without a session id or --sandbox: list only the sessions on the worker sandboxes of this identity.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --include-ended Without a session id: list ended sessions as well. Without --sandbox, this asks every worker sandbox live, waking any scaled to zero. [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Context options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` command\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Format options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --output, -o Set the output format [choices: \"text\", \"json\", \"yaml\", \"json-slim\", \"yaml-slim\", \"tf\", \"crd\", \"names\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --color Colorize the output [boolean] [default: true]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --ts Timestamp format if the output format is text (e.g., --output=text) [choices: \"iso\", \"local\", \"age\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Request options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --token Override the authorization token`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --endpoint Override the API URL`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --insecure, -k Ignore TLS errors [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Debug options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --verbose, -v Enable verbose output to stderr [boolean] [default: false]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --debug, -d Show all HTTP communications [boolean] [default: false]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --help Show help [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),_jsx(_components.p,{children:_jsx(_components.a,{href:`/cli-reference/using-cli/common-options`,children:`Common Options Reference`})})]}),`\n`,_jsxs(Accordion,{title:`Example`,id:`example-14`,children:[_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`List the sessions of a worker sandbox, ended ones included`}),`\n`]}),_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`cpln`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` session`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` get`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-worker-sandbox`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --include-ended`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --org`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-cpln-organization`})]}),`\n`]})})}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`List the sessions on the worker sandboxes of an identity`}),`\n`]}),_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`cpln`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` session`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` get`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --identity`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-identity`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --org`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-cpln-organization`})]}),`\n`]})})}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Show one session`}),`\n`]}),_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`cpln`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` session`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` get`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-session`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-worker-sandbox`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --org`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-cpln-organization`})]}),`\n`]})})})]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`4`,id:`sandbox-session-logs`,children:`sandbox session logs`}),`\n`,_jsx(_components.p,{children:`Show the log of a session, live or ended`}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Usage`})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`cpln sandbox session logs \u003csession> [OPTIONS]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`The log always holds the lifecycle lines of the session. The output of its processes is kept only when the session was created with `,_jsx(_components.code,{children:`--log`}),`.`]})}),`\n`,_jsxs(Accordion,{title:`Reference`,id:`reference-15`,children:[_jsx(CodeBlock,{filename:``,numberOfLines:`38`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`38`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Positionals:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` session The session id. [required]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Command options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --sandbox The worker sandbox holding the session. Omit it to go through the GVC.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --since Lookback window, e.g., 30m, 1h, 7d.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --from Start of the window: an ISO 8601 time or a duration ago, e.g., 2026-10-28T07:00:00Z, 7d.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --to End of the window: an ISO 8601 time or a duration ago.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --limit Maximum lines to return. [number]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --direction Read from the oldest line (forward) or the newest (backward). [choices: \"forward\", \"backward\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --source Only lines from this source: system, stdout, or stderr.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --level Only lines at this level or above.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --search Only lines containing this text.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --follow, -t, -f Keep printing new lines until the session ends. [boolean] [default: false]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Context options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` command\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Format options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --output, -o Set the output format [choices: \"text\", \"json\", \"yaml\", \"json-slim\", \"yaml-slim\", \"tf\", \"crd\", \"names\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --color Colorize the output [boolean] [default: true]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --ts Timestamp format if the output format is text (e.g., --output=text) [choices: \"iso\", \"local\", \"age\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Request options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --token Override the authorization token`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --endpoint Override the API URL`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --insecure, -k Ignore TLS errors [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Debug options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --verbose, -v Enable verbose output to stderr [boolean] [default: false]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --debug, -d Show all HTTP communications [boolean] [default: false]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --help Show help [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),_jsx(_components.p,{children:_jsx(_components.a,{href:`/cli-reference/using-cli/common-options`,children:`Common Options Reference`})})]}),`\n`,_jsxs(Accordion,{title:`Example`,id:`example-15`,children:[_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Show the log of a session`}),`\n`]}),_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Command`,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`cpln`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` session`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` logs`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-session`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-worker-sandbox`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --org`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-cpln-organization`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Output`,numberOfLines:`24`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`24`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`{`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"session\": \"demo-session\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"live\": true,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"truncated\": false,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"lines\": [`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"ts\": \"2026-11-20T10:00:01Z\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"source\": \"stdout\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"proc\": \"app\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"pid\": 412,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"message\": \"Serving on port 3000\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"ts\": \"2026-11-20T10:00:02Z\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"source\": \"system\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"level\": \"info\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"message\": \"process exited\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"fields\": {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"exitCode\": 0`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`}`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})})]}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Keep printing new lines until the session ends`}),`\n`]}),_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Command`,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`cpln`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` session`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` logs`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-session`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-worker-sandbox`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --follow`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --org`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-cpln-organization`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Output`,numberOfLines:`3`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`3`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`2026-11-20T10:00:01Z stdout [app] Serving on port 3000`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`2026-11-20T10:00:02Z system process exited`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})})]}),_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`Show only the `,_jsx(_components.code,{children:`stderr`}),` lines that contain the given text`]}),`\n`]}),_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`cpln`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` session`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` logs`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-session`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-worker-sandbox`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --source`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` stderr`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --search`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Traceback`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --org`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-cpln-organization`})]}),`\n`]})})})]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`4`,id:`sandbox-session-metrics`,children:`sandbox session metrics`}),`\n`,_jsx(_components.p,{children:`Show the resource series of a session, live or ended`}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Usage`})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`cpln sandbox session metrics \u003csession> [OPTIONS]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsxs(Accordion,{title:`Reference`,id:`reference-16`,children:[_jsx(CodeBlock,{filename:``,numberOfLines:`33`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`33`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Positionals:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` session The session id. [required]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Command options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --sandbox The worker sandbox holding the session. Omit it to go through the GVC.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --since Lookback window, e.g., 30m, 1h, 7d.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --from Start of the window: an ISO 8601 time or a duration ago, e.g., 2026-10-28T07:00:00Z, 7d.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --to End of the window: an ISO 8601 time or a duration ago.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --points Maximum points to return. [number]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Context options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` command\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Format options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --output, -o Set the output format [choices: \"text\", \"json\", \"yaml\", \"json-slim\", \"yaml-slim\", \"tf\", \"crd\", \"names\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --color Colorize the output [boolean] [default: true]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --ts Timestamp format if the output format is text (e.g., --output=text) [choices: \"iso\", \"local\", \"age\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Request options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --token Override the authorization token`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --endpoint Override the API URL`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --insecure, -k Ignore TLS errors [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Debug options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --verbose, -v Enable verbose output to stderr [boolean] [default: false]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --debug, -d Show all HTTP communications [boolean] [default: false]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --help Show help [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),_jsx(_components.p,{children:_jsx(_components.a,{href:`/cli-reference/using-cli/common-options`,children:`Common Options Reference`})})]}),`\n`,_jsxs(Accordion,{title:`Example`,id:`example-16`,children:[_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Show the resource series of a session, cut to one point`}),`\n`]}),_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Command`,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`cpln`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` session`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` metrics`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-session`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-worker-sandbox`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --points`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:` 1`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --org`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-cpln-organization`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Output`,numberOfLines:`19`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`19`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`{`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"session\": \"demo-session\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"live\": true,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"interval\": 5,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"points\": [`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"ts\": \"2026-11-20T10:00:05Z\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"cpuCount\": 1,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"cpuPct\": 12.5,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"cpuUsec\": 812000,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"memBytes\": 73400320,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"memLimit\": 536870912,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"cacheBytes\": 4194304,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"diskBytes\": 1048576,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"pids\": 3`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`}`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})})]}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Show the last hour of the resource series in at most 60 points`}),`\n`]}),_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`cpln`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` session`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` metrics`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-session`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-worker-sandbox`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --since`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 1h`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --points`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:` 60`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --org`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-cpln-organization`})]}),`\n`]})})})]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`4`,id:`sandbox-session-preview`,children:`sandbox session preview`}),`\n`,_jsx(_components.p,{children:`Open a session’s preview on a port in the browser`}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Usage`})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`cpln sandbox session preview \u003csession> [OPTIONS]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`A link to a `,_jsx(_components.code,{children:`token`}),` preview opens one browser once and expires shortly. A link to a `,_jsx(_components.code,{children:`public`}),` preview does not expire.`]})}),`\n`,_jsxs(Accordion,{title:`Reference`,id:`reference-17`,children:[_jsx(CodeBlock,{filename:``,numberOfLines:`31`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`31`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Positionals:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` session The session id. [required]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Command options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --sandbox The worker sandbox holding the session. Omit it to go through the GVC.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --port The port to open. Defaults to the one port the session declared. [number]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --print-url Print the link instead of opening it. A token preview's link opens one browser once and expires shortly; a public preview's link does not expire. [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Context options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` command\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Format options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --output, -o Set the output format [choices: \"text\", \"json\", \"yaml\", \"json-slim\", \"yaml-slim\", \"tf\", \"crd\", \"names\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --color Colorize the output [boolean] [default: true]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --ts Timestamp format if the output format is text (e.g., --output=text) [choices: \"iso\", \"local\", \"age\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Request options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --token Override the authorization token`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --endpoint Override the API URL`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --insecure, -k Ignore TLS errors [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Debug options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --verbose, -v Enable verbose output to stderr [boolean] [default: false]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --debug, -d Show all HTTP communications [boolean] [default: false]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --help Show help [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),_jsx(_components.p,{children:_jsx(_components.a,{href:`/cli-reference/using-cli/common-options`,children:`Common Options Reference`})})]}),`\n`,_jsxs(Accordion,{title:`Example`,id:`example-17`,children:[_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Open a session’s preview on port 3000 in the browser`}),`\n`]}),_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`cpln`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` session`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` preview`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-session`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-worker-sandbox`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --port`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:` 3000`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --org`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-cpln-organization`})]}),`\n`]})})}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Print the link instead of opening it`}),`\n`]}),_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`cpln`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` session`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` preview`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-session`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-worker-sandbox`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --port`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:` 3000`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --print-url`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --org`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-cpln-organization`})]}),`\n`]})})})]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`4`,id:`sandbox-session-processes`,children:`sandbox session processes`}),`\n`,_jsx(_components.p,{children:`List the running processes of a session`}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Usage`})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`cpln sandbox session processes \u003csession> [OPTIONS]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsxs(Accordion,{title:`Reference`,id:`reference-18`,children:[_jsx(CodeBlock,{filename:``,numberOfLines:`29`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`29`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Positionals:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` session The session id. [required]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Command options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --sandbox The worker sandbox holding the session. Omit it to go through the GVC.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Context options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` command\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Format options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --output, -o Set the output format [choices: \"text\", \"json\", \"yaml\", \"json-slim\", \"yaml-slim\", \"tf\", \"crd\", \"names\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --color Colorize the output [boolean] [default: true]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --ts Timestamp format if the output format is text (e.g., --output=text) [choices: \"iso\", \"local\", \"age\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Request options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --token Override the authorization token`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --endpoint Override the API URL`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --insecure, -k Ignore TLS errors [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Debug options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --verbose, -v Enable verbose output to stderr [boolean] [default: false]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --debug, -d Show all HTTP communications [boolean] [default: false]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --help Show help [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),_jsx(_components.p,{children:_jsx(_components.a,{href:`/cli-reference/using-cli/common-options`,children:`Common Options Reference`})})]}),`\n`,_jsx(Accordion,{title:`Example`,id:`example-18`,children:_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Command`,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`cpln`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` session`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` processes`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-session`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-worker-sandbox`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --org`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-cpln-organization`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Output`,numberOfLines:`19`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`19`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`{`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"processes\": [`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"pid\": 412,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"tag\": \"app\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"session\": \"demo-session\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"config\": {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"cmd\": \"python3\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"args\": [`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"-m\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"http.server\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"3000\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` ],`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"cwd\": \"/var/lib/devboxd/sessions/demo-session/workspace\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`}`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})})]})}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`4`,id:`sandbox-session-signal`,children:`sandbox session signal`}),`\n`,_jsx(_components.p,{children:`Send SIGTERM or SIGKILL to a process of a session`}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Usage`})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`cpln sandbox session signal \u003csession> --process PROCESS [OPTIONS]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsxs(Accordion,{title:`Reference`,id:`reference-19`,children:[_jsx(CodeBlock,{filename:``,numberOfLines:`31`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`31`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Positionals:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` session The session id. [required]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Command options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --sandbox The worker sandbox holding the session. Omit it to go through the GVC.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --process The process to signal: its pid, or the tag it was started with. [required]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --signal The signal to send. [choices: \"SIGTERM\", \"SIGKILL\"] [default: \"SIGTERM\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Context options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` command\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Format options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --output, -o Set the output format [choices: \"text\", \"json\", \"yaml\", \"json-slim\", \"yaml-slim\", \"tf\", \"crd\", \"names\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --color Colorize the output [boolean] [default: true]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --ts Timestamp format if the output format is text (e.g., --output=text) [choices: \"iso\", \"local\", \"age\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Request options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --token Override the authorization token`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --endpoint Override the API URL`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --insecure, -k Ignore TLS errors [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Debug options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --verbose, -v Enable verbose output to stderr [boolean] [default: false]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --debug, -d Show all HTTP communications [boolean] [default: false]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --help Show help [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),_jsx(_components.p,{children:_jsx(_components.a,{href:`/cli-reference/using-cli/common-options`,children:`Common Options Reference`})})]}),`\n`,_jsxs(Accordion,{title:`Example`,id:`example-19`,children:[_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Send SIGTERM (the default) to a process, named by its pid`}),`\n`]}),_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Command`,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`cpln`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` session`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` signal`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-session`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-worker-sandbox`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --process`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:` 412`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --org`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-cpln-organization`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Output`,numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Sent SIGTERM to process 412 in session demo-session`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})})]}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Send SIGKILL to a process, named by the tag it was started with`}),`\n`]}),_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Command`,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`cpln`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` session`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` signal`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-session`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-worker-sandbox`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --process`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` app`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --signal`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` SIGKILL`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --org`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-cpln-organization`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Output`,numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Sent SIGKILL to process app in session demo-session`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})})]})]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`4`,id:`sandbox-start`,children:`sandbox start`}),`\n`,_jsx(_components.p,{children:`Start one or more stopped sandboxes`}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Usage`})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`cpln sandbox start \u003cref...> [OPTIONS]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsxs(Accordion,{title:`Reference`,id:`reference-20`,children:[_jsx(CodeBlock,{filename:``,numberOfLines:`29`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`29`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Positionals:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` ref One or more resource references. Usually it is the name of the resource. [array] [required] [default: []]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Command options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --dry-run Validate the request and print the resource that would be written, without writing it. Defaults the output format to yaml-slim [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Context options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` command\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Format options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --output, -o Set the output format [choices: \"text\", \"json\", \"yaml\", \"json-slim\", \"yaml-slim\", \"tf\", \"crd\", \"names\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --color Colorize the output [boolean] [default: true]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --ts Timestamp format if the output format is text (e.g., --output=text) [choices: \"iso\", \"local\", \"age\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Request options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --token Override the authorization token`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --endpoint Override the API URL`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --insecure, -k Ignore TLS errors [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Debug options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --verbose, -v Enable verbose output to stderr [boolean] [default: false]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --debug, -d Show all HTTP communications [boolean] [default: false]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --help Show help [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),_jsx(_components.p,{children:_jsx(_components.a,{href:`/cli-reference/using-cli/common-options`,children:`Common Options Reference`})})]}),`\n`,_jsx(Accordion,{title:`Example`,id:`example-20`,children:_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`cpln`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` start`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-dev-sandbox`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --org`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-cpln-organization`})]}),`\n`]})})})}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`4`,id:`sandbox-stop`,children:`sandbox stop`}),`\n`,_jsx(_components.p,{children:`Stop one or more sandboxes until they are started; their home volumes are kept`}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Usage`})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`cpln sandbox stop \u003cref...> [OPTIONS]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`A stopped sandbox keeps its home volume and stays stopped until `,_jsx(_components.a,{href:`#sandbox-start`,children:`sandbox start`}),` is run. Nothing wakes it in between.`]})}),`\n`,_jsxs(Accordion,{title:`Reference`,id:`reference-21`,children:[_jsx(CodeBlock,{filename:``,numberOfLines:`29`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`29`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Positionals:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` ref One or more resource references. Usually it is the name of the resource. [array] [required] [default: []]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Command options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --dry-run Validate the request and print the resource that would be written, without writing it. Defaults the output format to yaml-slim [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Context options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` command\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Format options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --output, -o Set the output format [choices: \"text\", \"json\", \"yaml\", \"json-slim\", \"yaml-slim\", \"tf\", \"crd\", \"names\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --color Colorize the output [boolean] [default: true]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --ts Timestamp format if the output format is text (e.g., --output=text) [choices: \"iso\", \"local\", \"age\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Request options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --token Override the authorization token`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --endpoint Override the API URL`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --insecure, -k Ignore TLS errors [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Debug options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --verbose, -v Enable verbose output to stderr [boolean] [default: false]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --debug, -d Show all HTTP communications [boolean] [default: false]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --help Show help [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),_jsx(_components.p,{children:_jsx(_components.a,{href:`/cli-reference/using-cli/common-options`,children:`Common Options Reference`})})]}),`\n`,_jsx(Accordion,{title:`Example`,id:`example-21`,children:_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`cpln`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` stop`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-dev-sandbox`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --org`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-cpln-organization`})]}),`\n`]})})})}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`4`,id:`sandbox-tag`,children:`sandbox tag`}),`\n`,_jsx(_components.p,{children:`Manage the tags belonging to one or more referenced sandboxes`}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Usage`})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`cpln sandbox tag \u003cref...> --tag KEY=VALUE [OPTIONS]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(Note,{children:_jsx(_components.p,{children:`Built-in tags, which begin with cpln/*, can’t be modified.`})}),`\n`,_jsxs(Accordion,{title:`Reference`,id:`reference-22`,children:[_jsx(CodeBlock,{filename:``,numberOfLines:`31`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`31`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Positionals:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` ref One or more resource references. Usually it is the name of the resource. [array] [required] [default: []]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Command options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --tag Attach tags (e.g., --tag drink=water)`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --remove-tag Remove tags (e.g., --remove-tag tagname)`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --dry-run Validate the request and print the resource that would be written, without writing it. Defaults the output format to yaml-slim [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Context options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` command\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Format options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --output, -o Set the output format [choices: \"text\", \"json\", \"yaml\", \"json-slim\", \"yaml-slim\", \"tf\", \"crd\", \"names\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --color Colorize the output [boolean] [default: true]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --ts Timestamp format if the output format is text (e.g., --output=text) [choices: \"iso\", \"local\", \"age\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Request options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --token Override the authorization token`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --endpoint Override the API URL`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --insecure, -k Ignore TLS errors [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Debug options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --verbose, -v Enable verbose output to stderr [boolean] [default: false]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --debug, -d Show all HTTP communications [boolean] [default: false]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --help Show help [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),_jsx(_components.p,{children:_jsx(_components.a,{href:`/cli-reference/using-cli/common-options`,children:`Common Options Reference`})})]}),`\n`,_jsxs(Accordion,{title:`Example`,id:`example-22`,children:[_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Add a tag`}),`\n`]}),_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Command`,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`cpln`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` tag`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-dev-sandbox`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --tag`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` drink=water`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --org`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-cpln-organization`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Output`,numberOfLines:`10`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`10`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`+-----------------+-----------------+--------+------+---------------+------------------------------------------------+------------------------+`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|NAME |DESCRIPTION |GVC |READY |CREATED |ENDPOINT |TAGS |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|-----------------|-----------------|--------|------|---------------|------------------------------------------------|------------------------|`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|demo-dev-sandbox |demo-dev-sandbox |default |true |12 minutes ago |https://demo-dev-sandbox-4razc9rbmer7r.cpln.app |cpln/dev-type=\"devbox\" |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`| | | | | | |cpln/kata=\"true\" |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`| | | | | | |cpln/sandbox=\"true\" |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`| | | | | | |cpln/scaleToZero=\"true\" |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`| | | | | | |drink=\"water\" |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`+-----------------+-----------------+--------+------+---------------+------------------------------------------------+------------------------+`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})})]}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Update same tag (after running the example above)`}),`\n`]}),_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Command`,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`cpln`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` tag`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-dev-sandbox`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --tag`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` drink=coffee`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --org`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-cpln-organization`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Output`,numberOfLines:`10`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`10`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`+-----------------+-----------------+--------+------+---------------+------------------------------------------------+------------------------+`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|NAME |DESCRIPTION |GVC |READY |CREATED |ENDPOINT |TAGS |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|-----------------|-----------------|--------|------|---------------|------------------------------------------------|------------------------|`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|demo-dev-sandbox |demo-dev-sandbox |default |true |12 minutes ago |https://demo-dev-sandbox-4razc9rbmer7r.cpln.app |cpln/dev-type=\"devbox\" |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`| | | | | | |cpln/kata=\"true\" |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`| | | | | | |cpln/sandbox=\"true\" |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`| | | | | | |cpln/scaleToZero=\"true\" |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`| | | | | | |drink=\"coffee\" |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`+-----------------+-----------------+--------+------+---------------+------------------------------------------------+------------------------+`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})})]}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Remove tag (after running the example above)`}),`\n`]}),_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Command`,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`cpln`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` tag`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-dev-sandbox`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --remove-tag`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` drink`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --org`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-cpln-organization`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Output`,numberOfLines:`9`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`9`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`+-----------------+-----------------+--------+------+---------------+------------------------------------------------+------------------------+`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|NAME |DESCRIPTION |GVC |READY |CREATED |ENDPOINT |TAGS |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|-----------------|-----------------|--------|------|---------------|------------------------------------------------|------------------------|`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|demo-dev-sandbox |demo-dev-sandbox |default |true |12 minutes ago |https://demo-dev-sandbox-4razc9rbmer7r.cpln.app |cpln/dev-type=\"devbox\" |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`| | | | | | |cpln/kata=\"true\" |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`| | | | | | |cpln/sandbox=\"true\" |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`| | | | | | |cpln/scaleToZero=\"true\" |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`+-----------------+-----------------+--------+------+---------------+------------------------------------------------+------------------------+`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})})]})]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`4`,id:`sandbox-update`,children:`sandbox update`}),`\n`,_jsx(_components.p,{children:`Update properties of the referenced sandbox`}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Usage`})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`cpln sandbox update \u003cref> --set UPDATE_PROPERTY [OPTIONS]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsxs(Accordion,{title:`Reference`,id:`reference-23`,children:[_jsx(CodeBlock,{filename:``,numberOfLines:`47`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`47`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Positionals:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` ref The resource reference. Usually it is the name of the resource. [required]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Update Properties:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --set Update the following properties (e.g., --set description=\"Updated Description\"):`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` description string`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` tags.\u003ckey> string`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` spec.identityLink string`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` spec.containers.\u003cname>.image string`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` spec.containers.\u003cname>.cpu string`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` spec.containers.\u003cname>.memory string`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` spec.containers.\u003cname>.env.\u003cname>.value string`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` spec.sandbox.appPort number`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` spec.sandbox.scaleToZeroDelay number`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` spec.sandbox.scaling.maxSessions number`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` spec.sandbox.scaling.minWorkers number`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` spec.sandbox.scaling.maxWorkers number`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` spec.sandbox.scaling.idleDeleteDelay number`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --unset Unset a property (same paths as --set, e.g., --unset description)`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Command options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --dry-run Validate the request and print the resource that would be written, without writing it. Defaults the output format to yaml-slim [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Context options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --profile Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --org Override the organization. The default organization can be set in your profile by using the `cpln profile update` command\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\" --gvc Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` command\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Format options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --output, -o Set the output format [choices: \"text\", \"json\", \"yaml\", \"json-slim\", \"yaml-slim\", \"tf\", \"crd\", \"names\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --color Colorize the output [boolean] [default: true]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --ts Timestamp format if the output format is text (e.g., --output=text) [choices: \"iso\", \"local\", \"age\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --max Maximum number of records to show. A value less than 1 will return all records. [number] [default: 50]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Request options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --token Override the authorization token`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --endpoint Override the API URL`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --insecure, -k Ignore TLS errors [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Debug options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --verbose, -v Enable verbose output to stderr [boolean] [default: false]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --debug, -d Show all HTTP communications [boolean] [default: false]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Options:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --help Show help [boolean]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),_jsx(_components.p,{children:_jsx(_components.a,{href:`/cli-reference/using-cli/common-options`,children:`Common Options Reference`})})]}),`\n`,_jsx(Accordion,{title:`Options`,id:`options-1`,children:_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`The `,_jsx(_components.code,{children:`--set`}),` option allows the modification of the following sandbox properties:`,`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`description`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Description of the sandbox`}),`\n`,_jsx(_components.li,{children:`Type: string`}),`\n`]}),`\n`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`tags`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Tags (key=value) associated with the sandbox`}),`\n`,_jsx(_components.li,{children:`Type: string`}),`\n`]}),`\n`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`spec.identityLink`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`The identity the sandbox runs as`}),`\n`,_jsx(_components.li,{children:`Type: string`}),`\n`]}),`\n`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`spec.containers.\u003cname>.image`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`The container image the sandbox runs`}),`\n`,_jsx(_components.li,{children:`Type: string`}),`\n`]}),`\n`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`spec.containers.\u003cname>.cpu`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`The amount of cpu units available to the sandbox`}),`\n`,_jsx(_components.li,{children:`Type: string`}),`\n`]}),`\n`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`spec.containers.\u003cname>.memory`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`The amount of memory available to the sandbox`}),`\n`,_jsx(_components.li,{children:`Type: string`}),`\n`]}),`\n`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`spec.containers.\u003cname>.env.\u003cname>.value`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`The environment variables to be available to the sandbox container`}),`\n`,_jsx(_components.li,{children:`Type: string`}),`\n`]}),`\n`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`spec.sandbox.appPort`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`The port the application inside the sandbox listens on`}),`\n`,_jsx(_components.li,{children:`Default: 8080`}),`\n`,_jsx(_components.li,{children:`Type: number`}),`\n`]}),`\n`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`spec.sandbox.scaleToZeroDelay`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Idle seconds (30 to 3600) before the sandbox scales to zero`}),`\n`,_jsx(_components.li,{children:`Default: 300`}),`\n`,_jsx(_components.li,{children:`Type: number`}),`\n`]}),`\n`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`spec.sandbox.scaling.maxSessions`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Worker sandboxes only: the sessions (1 to 500) one worker sandbox holds at most`}),`\n`,_jsx(_components.li,{children:`Default: 20`}),`\n`,_jsx(_components.li,{children:`Type: number`}),`\n`]}),`\n`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`spec.sandbox.scaling.minWorkers`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Worker sandboxes only: the worker sandboxes (1 to 100) kept for the identity`}),`\n`,_jsx(_components.li,{children:`Default: 1`}),`\n`,_jsx(_components.li,{children:`Type: number`}),`\n`]}),`\n`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`spec.sandbox.scaling.maxWorkers`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Worker sandboxes only: the worker sandboxes (1 to 100) the identity grows to at most`}),`\n`,_jsx(_components.li,{children:`Default: 10`}),`\n`,_jsx(_components.li,{children:`Type: number`}),`\n`]}),`\n`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`spec.sandbox.scaling.idleDeleteDelay`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Worker sandboxes only: seconds (300 to 604800) a worker sandbox the server added stays empty before it is deleted`}),`\n`,_jsx(_components.li,{children:`Default: 3600`}),`\n`,_jsx(_components.li,{children:`Type: number`}),`\n`]}),`\n`]}),`\n`]}),`\n`]}),`\n`]})}),`\n`,_jsxs(Accordion,{title:`Example`,id:`example-23`,children:[_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Update a sandbox’s description`}),`\n`]}),_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Command`,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`cpln`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` update`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-dev-sandbox`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --set`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` description=\"Demo dev sandbox\"`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --org`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-cpln-organization`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Output`,numberOfLines:`9`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`9`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`+-----------------+-----------------+--------+------+---------------+------------------------------------------------+------------------------+`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|NAME |DESCRIPTION |GVC |READY |CREATED |ENDPOINT |TAGS |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|-----------------|-----------------|--------|------|---------------|------------------------------------------------|------------------------|`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`|demo-dev-sandbox |Demo dev sandbox |default |true |12 minutes ago |https://demo-dev-sandbox-4razc9rbmer7r.cpln.app |cpln/dev-type=\"devbox\" |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`| | | | | | |cpln/kata=\"true\" |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`| | | | | | |cpln/sandbox=\"true\" |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`| | | | | | |cpln/scaleToZero=\"true\" |`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`+-----------------+-----------------+--------+------+---------------+------------------------------------------------+------------------------+`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})})]}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Set how long a sandbox stays idle before it scales to zero`}),`\n`]}),_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`cpln`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` update`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-dev-sandbox`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --set`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` spec.sandbox.scaleToZeroDelay=`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`600`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --org`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-cpln-organization`})]}),`\n`]})})}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Set the most sessions a worker sandbox holds`}),`\n`]}),_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`cpln`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` sandbox`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` update`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-worker-sandbox`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --set`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` spec.sandbox.scaling.maxSessions=`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`50`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --org`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` demo-cpln-organization`})]}),`\n`]})})})]}),`\n`,_jsx(_components.hr,{})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"sandbox","description":"cpln sandbox: Create and manage dev and agent sandboxes, connect to a dev sandbox, and run sessions on an agent sandbox.","keywords":["cpln sandbox","sandbox create","sandbox connect","dev sandbox","agent sandbox","worker sandbox","sandbox session","session exec","cloud ide","sandbox ssh","sandbox vscode","sandbox cursor","code execution","ai agent sandbox","scale to zero"],"href":"/cli-reference/commands/sandbox"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"sandbox access-report","slug":"sandbox-access-report","depth":4,"children":[]},{"title":"sandbox audit","slug":"sandbox-audit","depth":4,"children":[]},{"title":"sandbox connect","slug":"sandbox-connect","depth":4,"children":[]},{"title":"sandbox create","slug":"sandbox-create","depth":4,"children":[]},{"title":"sandbox delete","slug":"sandbox-delete","depth":4,"children":[]},{"title":"sandbox edit","slug":"sandbox-edit","depth":4,"children":[]},{"title":"sandbox eventlog","slug":"sandbox-eventlog","depth":4,"children":[]},{"title":"sandbox get","slug":"sandbox-get","depth":4,"children":[]},{"title":"sandbox patch","slug":"sandbox-patch","depth":4,"children":[]},{"title":"sandbox permissions","slug":"sandbox-permissions","depth":4,"children":[]},{"title":"sandbox session","slug":"sandbox-session","depth":4,"children":[]},{"title":"sandbox session connect","slug":"sandbox-session-connect","depth":4,"children":[]},{"title":"sandbox session create","slug":"sandbox-session-create","depth":4,"children":[]},{"title":"sandbox session delete","slug":"sandbox-session-delete","depth":4,"children":[]},{"title":"sandbox session exec","slug":"sandbox-session-exec","depth":4,"children":[]},{"title":"sandbox session get","slug":"sandbox-session-get","depth":4,"children":[]},{"title":"sandbox session logs","slug":"sandbox-session-logs","depth":4,"children":[]},{"title":"sandbox session metrics","slug":"sandbox-session-metrics","depth":4,"children":[]},{"title":"sandbox session preview","slug":"sandbox-session-preview","depth":4,"children":[]},{"title":"sandbox session processes","slug":"sandbox-session-processes","depth":4,"children":[]},{"title":"sandbox session signal","slug":"sandbox-session-signal","depth":4,"children":[]},{"title":"sandbox start","slug":"sandbox-start","depth":4,"children":[]},{"title":"sandbox stop","slug":"sandbox-stop","depth":4,"children":[]},{"title":"sandbox tag","slug":"sandbox-tag","depth":4,"children":[]},{"title":"sandbox update","slug":"sandbox-update","depth":4,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/controlplanecorporation/20452e834d3719a6/content/legacy-cli-hash-redirects.js","/_mintlify/custom/controlplanecorporation/dd1961f62f732454/content/sync-tabs.js"],"subdomain":"controlplanecorporation","siteName":"Control Plane","title":"sandbox - Control Plane","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-20T17:45:27.821Z","originalFileLocation":"cli-reference/commands/sandbox.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"cpln sandbox: Create and manage dev and agent sandboxes, connect to a dev sandbox, and run sessions on an agent sandbox.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Control Plane\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/controlplanecorporation/N_jUg8p-q778yjKC/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/controlplanecorporation/N_jUg8p-q778yjKC/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/controlplanecorporation/N_jUg8p-q778yjKC/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/controlplanecorporation/N_jUg8p-q778yjKC/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/controlplanecorporation/N_jUg8p-q778yjKC/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/controlplanecorporation/N_jUg8p-q778yjKC/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/controlplanecorporation/N_jUg8p-q778yjKC/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/controlplanecorporation/N_jUg8p-q778yjKC/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/controlplanecorporation/N_jUg8p-q778yjKC/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"sandbox - Control Plane\">\u003cmeta data-mint-head property=\"og:description\" content=\"cpln sandbox: Create and manage dev and agent sandboxes, connect to a dev sandbox, and run sessions on an agent sandbox.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Control Plane\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.controlplane.com/cli-reference/commands/sandbox\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://controlplanecorporation.mintlify.site/_mintlify/api/og/v2?division=Commands\u0026amp;title=sandbox\u0026amp;description=cpln+sandbox%3A+Create+and+manage+dev+and+agent+sandboxes%2C+connect+to+a+dev+sandbox%2C+and+run+sessions+on+an+agent+sandbox.\u0026amp;theme=565533155d08f0e2a83ec355\u0026amp;signature=8dd6e0509549a86f69c1cac0972fc02ed8dd2e86a82b034ac11eb47c8bf7f2fe\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"sandbox - Control Plane\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"cpln sandbox: Create and manage dev and agent sandboxes, connect to a dev sandbox, and run sessions on an agent sandbox.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://controlplanecorporation.mintlify.site/_mintlify/api/og/v2?division=Commands\u0026amp;title=sandbox\u0026amp;description=cpln+sandbox%3A+Create+and+manage+dev+and+agent+sandboxes%2C+connect+to+a+dev+sandbox%2C+and+run+sessions+on+an+agent+sandbox.\u0026amp;theme=565533155d08f0e2a83ec355\u0026amp;signature=8dd6e0509549a86f69c1cac0972fc02ed8dd2e86a82b034ac11eb47c8bf7f2fe\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/controlplanecorporation/N_jUg8p-q778yjKC/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Control Plane\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1563ff\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.controlplane.com/cli-reference/commands/sandbox\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/cli-reference/commands/sandbox.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.controlplane.com/#organization\",\"name\":\"Control Plane\",\"url\":\"https://docs.controlplane.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/controlplanecorporation/hwvJiAoqIziVJ3gK/logos/dark.svg?fit=max\u0026auto=format\u0026n=hwvJiAoqIziVJ3gK\u0026q=85\u0026s=ec7b5a4bb958adc4d92dedfb41ab2e3c\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.controlplane.com#website\",\"name\":\"Control Plane\",\"url\":\"https://docs.controlplane.com\",\"publisher\":{\"@id\":\"https://docs.controlplane.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.controlplane.com/cli-reference/commands/sandbox#webpage\",\"url\":\"https://docs.controlplane.com/cli-reference/commands/sandbox\",\"name\":\"sandbox\",\"description\":\"cpln sandbox: Create and manage dev and agent sandboxes, connect to a dev sandbox, and run sessions on an agent sandbox.\",\"dateModified\":\"2026-11-20T17:45:27.821Z\",\"isPartOf\":{\"@id\":\"https://docs.controlplane.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.controlplane.com/cli-reference/commands/sandbox#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.controlplane.com/cli-reference/commands/sandbox#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Commands\",\"item\":\"https://docs.controlplane.com/cli-reference/commands/account\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"sandbox\",\"item\":\"https://docs.controlplane.com/cli-reference/commands/sandbox\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.controlplane.com/cli-reference/commands/sandbox#article\",\"headline\":\"sandbox\",\"name\":\"sandbox\",\"description\":\"cpln sandbox: Create and manage dev and agent sandboxes, connect to a dev sandbox, and run sessions on an agent sandbox.\",\"url\":\"https://docs.controlplane.com/cli-reference/commands/sandbox\",\"mainEntityOfPage\":{\"@id\":\"https://docs.controlplane.com/cli-reference/commands/sandbox#webpage\"},\"dateModified\":\"2026-11-20T17:45:27.821Z\",\"keywords\":\"cpln sandbox, sandbox create, sandbox connect, dev sandbox, agent sandbox, worker sandbox, sandbox session, session exec, cloud ide, sandbox ssh, sandbox vscode, sandbox cursor, code execution, ai agent sandbox, scale to zero\",\"publisher\":{\"@id\":\"https://docs.controlplane.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.controlplane.com#website\"}}]}\u003c/script>","agentPointerHref":"/cli-reference/commands/sandbox.md","siteName":"Control Plane","nav":{"global":{"anchors":[{"anchor":"Website","icon":"compass","href":"https://controlplane.com"},{"anchor":"Status","icon":"signal","href":"https://status.cpln.io/"},{"anchor":"Blog","icon":"newspaper","href":"https://controlplane.com/blog"},{"anchor":"FAQ","icon":"question","href":"https://controlplane.com/faq"},{"anchor":"Product Demos","icon":"video","href":"https://controlplane.com/product-demos"}]},"tabs":[{"tab":"Home","pages":[{"title":"Home","href":"/introduction"}]},{"tab":"How-to Guides","pages":[{"title":"How-to Guides","href":"/guides/overview"}]},{"tab":"Template Catalog","pages":[{"title":"Template Catalog","href":"/template-catalog/overview"}]},{"tab":"Managed Kubernetes","pages":[{"title":"Managed Kubernetes","href":"/mk8s/overview"}]},{"tab":"CPLN BYOK","pages":[{"title":"CPLN BYOK","href":"/byok/overview"}]},{"tab":"AI Agents","pages":[{"title":"AI Agents","href":"/ai/overview"}]},{"tab":"Infra as Code","pages":[{"title":"Infra as Code","href":"/iac/overview"}]},{"tab":"CLI Reference","groups":[{"group":"CLI Reference","pages":[{"title":"CLI Reference","sidebarTitle":"Overview","href":"/cli-reference/overview"},{"title":"Installation","href":"/cli-reference/installation"},{"title":"Release Notes","href":"/cli-reference/release-notes"},{"group":"Getting Started","pages":[{"title":"Quickstart","href":"/cli-reference/get-started/quickstart"},{"title":"Authentication","href":"/cli-reference/get-started/authentication"},{"title":"Profiles","href":"/cli-reference/get-started/profiles"},{"title":"Images","href":"/cli-reference/get-started/images"}]},{"group":"Using the CLI","pages":[{"title":"Getting Help","href":"/cli-reference/using-cli/help"},{"title":"Common Options","href":"/cli-reference/using-cli/common-options"},{"title":"Output Formats","href":"/cli-reference/using-cli/output"},{"title":"Shell Completion","href":"/cli-reference/using-cli/shell-completion"},{"title":"Troubleshooting","href":"/cli-reference/using-cli/troubleshooting"}]},{"group":"CI/CD \u0026 Development","pages":[{"title":"CI/CD Usage","href":"/cli-reference/ci-cd-development/ci-cd"},{"title":"Using the CLI in Containers","href":"/cli-reference/ci-cd-development/container-image"}]}]},{"group":"Commands","pages":[{"title":"account","href":"/cli-reference/commands/account"},{"title":"agent","href":"/cli-reference/commands/agent"},{"title":"apply","href":"/cli-reference/commands/apply"},{"title":"auditctx","href":"/cli-reference/commands/auditctx"},{"title":"cloudaccount","href":"/cli-reference/commands/cloudaccount"},{"title":"convert","href":"/cli-reference/commands/convert"},{"title":"cp","href":"/cli-reference/commands/cp"},{"title":"delete","href":"/cli-reference/commands/delete"},{"title":"domain","href":"/cli-reference/commands/domain"},{"title":"group","href":"/cli-reference/commands/group"},{"title":"gvc","href":"/cli-reference/commands/gvc"},{"title":"helm","href":"/cli-reference/commands/helm"},{"title":"identity","href":"/cli-reference/commands/identity"},{"title":"image","href":"/cli-reference/commands/image"},{"title":"ipset","href":"/cli-reference/commands/ipset"},{"title":"location","href":"/cli-reference/commands/location"},{"title":"login","href":"/cli-reference/commands/login"},{"title":"logs","href":"/cli-reference/commands/logs"},{"title":"metrics","href":"/cli-reference/commands/metrics"},{"title":"misc","href":"/cli-reference/commands/misc"},{"title":"mk8s","href":"/cli-reference/commands/mk8s"},{"title":"operator","href":"/cli-reference/commands/operator"},{"title":"org","href":"/cli-reference/commands/org"},{"title":"policy","href":"/cli-reference/commands/policy"},{"title":"port-forward","href":"/cli-reference/commands/port-forward"},{"title":"profile","href":"/cli-reference/commands/profile"},{"title":"quota","href":"/cli-reference/commands/quota"},{"title":"rest","description":"cpln rest — Submit raw REST requests directly against the Control Plane API.","href":"/cli-reference/commands/rest"},{"title":"sandbox","href":"/cli-reference/commands/sandbox"},{"title":"sandboximage","description":"cpln sandboximage: Build and manage sandbox images, the custom images that dev sandboxes and sandbox sessions run.","href":"/cli-reference/commands/sandboximage"},{"title":"secret","href":"/cli-reference/commands/secret"},{"title":"serviceaccount","href":"/cli-reference/commands/serviceaccount"},{"title":"stack","href":"/cli-reference/commands/stack"},{"title":"task","href":"/cli-reference/commands/task"},{"title":"upgrade","href":"/cli-reference/commands/upgrade"},{"title":"user","href":"/cli-reference/commands/user"},{"title":"version","href":"/cli-reference/commands/version"},{"title":"volumeset","href":"/cli-reference/commands/volumeset"},{"title":"workload","href":"/cli-reference/commands/workload"}]}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/api-reference/api"}]}]},"basePath":"","title":"sandbox - Control Plane","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":[],"chunks":[]}