Access to the Rippling CLI is gated behind the Developer Program, which is currently in a closed beta.

rippling sandbox create

Creates a new sandbox.

Flag	Type	Required	Description
--name	string	yes	Display name.
--type	string	yes	Sandbox type: developer or full data.
--description	string	no	Sandbox description.
--config-override-file	file	no	JSON for config_override. - reads stdin. developer.company_size accepts MEDIUM.
--input	file	no	Full JSON body from a file, or stdin with -. Cannot be combined with field flags.
--json	boolean	no	Print the response as indented JSON.

Example:

rippling --context developer-account sandbox create --name "Editor" --type developer --json
rippling --context developer-account sandbox create --name "Editor" --type developer --config-override-file editor-sandbox-config.json --json

rippling sandbox list

Lists available sandboxes.

Flag	Type	Required	Description
--cursor	string	no	Pagination cursor.
--filter	string	no	Filter expression.
--limit	string	no	Maximum results. Default 10. Maximum 100.
--order-by	string	no	Sort expression.
--json	boolean	no	Print the response as indented JSON.

Example:

rippling --context developer-account sandbox list
rippling --context developer-account sandbox list --json

rippling sandbox get

Reads a specific sandbox.

Flag	Type	Required	Description
--id	string	yes	Sandbox ID to return.
--json	boolean	no	Print the response as indented JSON.

Example:

rippling sandbox get --id <sandbox-id>
rippling sandbox get --id <sandbox-id> --json

rippling sandbox use

Stores a sandbox as a named context and sets that context as the default.

Flag	Type	Required	Description
--alias	string	no	Developer sandbox alias (handle).
--id	string	no	Developer sandbox ID.
--context-name	string	no	Context name to create or update.

Example:

rippling --context developer-account sandbox use --alias <handle> --context-name sandbox-editor
rippling --context developer-account sandbox use --id <sandbox-id> --context-name sandbox-installer

rippling api sandbox login

Signs into a sandbox account.

Flag	Type	Required	Description
--alias	string	no	Developer sandbox alias (handle). Pass this or --id.
--id	string	no	Developer sandbox ID. Pass this or --alias.
--context-name	string	no	Context name to create or update. Must differ from the developer-account context.

Example:

rippling --context developer-account api sandbox login --alias <handle> --context-name sandbox-editor

rippling sandbox delete

Deletes a sandbox.

Flag	Type	Required	Description
--id	string	yes	Sandbox ID to delete.
--json	boolean	no	Print the response as indented JSON.

Example:

rippling sandbox delete --id <sandbox-id>
rippling sandbox delete --id <sandbox-id> --json