skills/modelstudioai__cli
1
0
Fork 0
mirror of https://github.com/modelstudioai/cli.git synced 2026-09-14 19:49:23 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
332efb05b8e28636f68e9608c4dc566c1c4c977f
modelstudioai__cli/skills/bailian-sandbox/reference/sandbox.md
T
chenanran555 332efb05b8 feat(sandbox): add Bailian Sandbox lifecycle commands
2026-09-07 15:11:51 +08:00

36 KiB
Raw Blame History

bl sandbox commands

Auto-generated from packages/cli/src/commands.ts. Do not edit by hand. Regenerate: pnpm --filter bailian-cli run generate:reference.

Index: index.md

Commands in this group

Command Authentication Description
bl sandbox connect API Key Connect to a Sandbox instance and return connection information
bl sandbox create API Key Create a Sandbox instance
bl sandbox delete API Key Release a Sandbox instance
bl sandbox get API Key Get Sandbox instance details
bl sandbox list API Key List Sandbox instances
bl sandbox pause API Key Pause a Sandbox instance
bl sandbox resume API Key Resume a Sandbox instance and return connection information
bl sandbox template build-status API Key Get Sandbox template build status
bl sandbox template create API Key Create a Sandbox template
bl sandbox template delete API Key Delete a Sandbox template
bl sandbox template get API Key Get Sandbox template details
bl sandbox template list API Key List Sandbox templates
bl sandbox template update API Key Update a Sandbox template

Command details

bl sandbox connect

Field Value
Name sandbox connect
Description Connect to a Sandbox instance and return connection information
Authentication API Key
Usage bl sandbox connect --sandbox-id <id> [--instance-timeout <seconds>] [--show-credentials]

Flags

Flag Type Required Description
--workspace-id <id> string no Workspace ID for the Sandbox endpoint (or set BAILIAN_WORKSPACE_ID)
--sandbox-id <id> string yes Sandbox instance ID
--body <json|@path> string no JSON request body, inline or loaded from an @file path; explicit flags override it
--instance-timeout <seconds> number no Sandbox lifetime after this operation (300-604800 seconds)
--show-credentials switch no Print envd and traffic access tokens instead of redacting them
--api-key <key> string no API key
--base-url <url> string no API base URL

Notes

  • Auth: uses a Bailian API Key as an Authorization Bearer token; no E2B key is sent.
  • The workspace is resolved from --workspace-id, BAILIAN_WORKSPACE_ID, then config workspace_id.
  • Sandbox is currently available in cn-beijing only and requires prior SLR authorization.
  • Global --timeout limits HTTP requests and total template-build polling; --instance-timeout maps to the Sandbox API lifetime field.

Examples

bl sandbox connect --sandbox-id sbx-xxx --instance-timeout 3600

bl sandbox connect --sandbox-id sbx-xxx --show-credentials --output json

bl sandbox create

Field Value
Name sandbox create
Description Create a Sandbox instance
Authentication API Key
Usage bl sandbox create (--template-id <id> | --body <json|@path>) [flags]

Flags

Flag Type Required Description
--workspace-id <id> string no Workspace ID for the Sandbox endpoint (or set BAILIAN_WORKSPACE_ID)
--body <json|@path> string no JSON request body, inline or loaded from an @file path; explicit flags override it
--template-id <id> string no Ready template ID; may alternatively be supplied as templateID in --body
--instance-timeout <seconds> number no Sandbox lifetime after this operation (300-604800 seconds)
--allow-internet-access <bool> boolean no Allow public internet access
--metadata <key=value> array no Instance metadata entry; repeat for multiple values
--env <key=value> array no Instance environment variable; repeat for multiple values
--auto-pause <bool> boolean no Pause the instance when its timeout expires
--auto-resume <bool> boolean no Automatically resume a paused instance when connecting
--allow-out <address> array no Outbound allow-list entry; repeat for multiple values
--deny-out <address> array no Outbound deny-list entry; repeat for multiple values
--mask-request-host <host> string no Override the outbound request Host header
--show-credentials switch no Print envd and traffic access tokens instead of redacting them
--api-key <key> string no API key
--base-url <url> string no API base URL

Notes

  • Auth: uses a Bailian API Key as an Authorization Bearer token; no E2B key is sent.
  • The workspace is resolved from --workspace-id, BAILIAN_WORKSPACE_ID, then config workspace_id.
  • Sandbox is currently available in cn-beijing only and requires prior SLR authorization.
  • Global --timeout limits HTTP requests and total template-build polling; --instance-timeout maps to the Sandbox API lifetime field.

Examples

bl sandbox create --template-id tpl-xxx --instance-timeout 3600

bl sandbox create --body @sandbox.json --dry-run --output json

bl sandbox create --template-id tpl-xxx --show-credentials --output json

bl sandbox delete

Field Value
Name sandbox delete
Description Release a Sandbox instance
Authentication API Key
Usage bl sandbox delete --sandbox-id <id>
Risk high
Risk message This permanently releases the Sandbox instance and cannot be undone.

Agent safety: Never add --yes automatically. On type="requires_confirmation", stop and ask for explicit user confirmation of the same action and scope.

Flags

Flag Type Required Description
--workspace-id <id> string no Workspace ID for the Sandbox endpoint (or set BAILIAN_WORKSPACE_ID)
--sandbox-id <id> string yes Sandbox instance ID
--yes switch no Confirm this high-risk operation
--api-key <key> string no API key
--base-url <url> string no API base URL

Notes

  • Auth: uses a Bailian API Key as an Authorization Bearer token; no E2B key is sent.
  • The workspace is resolved from --workspace-id, BAILIAN_WORKSPACE_ID, then config workspace_id.
  • Sandbox is currently available in cn-beijing only and requires prior SLR authorization.
  • Global --timeout limits HTTP requests and total template-build polling; --instance-timeout maps to the Sandbox API lifetime field.

Examples

bl sandbox delete --sandbox-id sbx-xxx --dry-run

# Only after explicit user confirmation:
bl sandbox delete --sandbox-id sbx-xxx --yes

bl sandbox get

Field Value
Name sandbox get
Description Get Sandbox instance details
Authentication API Key
Usage bl sandbox get --sandbox-id <id> [--show-credentials]

Flags

Flag Type Required Description
--workspace-id <id> string no Workspace ID for the Sandbox endpoint (or set BAILIAN_WORKSPACE_ID)
--sandbox-id <id> string yes Sandbox instance ID
--show-credentials switch no Print envd and traffic access tokens instead of redacting them
--api-key <key> string no API key
--base-url <url> string no API base URL

Notes

  • Auth: uses a Bailian API Key as an Authorization Bearer token; no E2B key is sent.
  • The workspace is resolved from --workspace-id, BAILIAN_WORKSPACE_ID, then config workspace_id.
  • Sandbox is currently available in cn-beijing only and requires prior SLR authorization.
  • Global --timeout limits HTTP requests and total template-build polling; --instance-timeout maps to the Sandbox API lifetime field.

Examples

bl sandbox get --sandbox-id sbx-xxx

bl sandbox get --sandbox-id sbx-xxx --show-credentials --output json

bl sandbox list

Field Value
Name sandbox list
Description List Sandbox instances
Authentication API Key
Usage bl sandbox list [--template-id <id>] [--sandbox-id <id>] [--state <state>] [--limit <n>]

Flags

Flag Type Required Description
--workspace-id <id> string no Workspace ID for the Sandbox endpoint (or set BAILIAN_WORKSPACE_ID)
--template-id <id> string no Filter by template ID
--sandbox-id <id> string no Filter by sandbox ID
--state <state> string no Filter by state, for example running or paused
--limit <n> number no Maximum results (1-50)
--api-key <key> string no API key
--base-url <url> string no API base URL

Notes

  • Auth: uses a Bailian API Key as an Authorization Bearer token; no E2B key is sent.
  • The workspace is resolved from --workspace-id, BAILIAN_WORKSPACE_ID, then config workspace_id.
  • Sandbox is currently available in cn-beijing only and requires prior SLR authorization.
  • Global --timeout limits HTTP requests and total template-build polling; --instance-timeout maps to the Sandbox API lifetime field.

Examples

bl sandbox list

bl sandbox list --state running --limit 20

bl sandbox list --template-id tpl-xxx --output json

bl sandbox pause

Field Value
Name sandbox pause
Description Pause a Sandbox instance
Authentication API Key
Usage bl sandbox pause --sandbox-id <id>

Flags

Flag Type Required Description
--workspace-id <id> string no Workspace ID for the Sandbox endpoint (or set BAILIAN_WORKSPACE_ID)
--sandbox-id <id> string yes Sandbox instance ID
--api-key <key> string no API key
--base-url <url> string no API base URL

Notes

  • Auth: uses a Bailian API Key as an Authorization Bearer token; no E2B key is sent.
  • The workspace is resolved from --workspace-id, BAILIAN_WORKSPACE_ID, then config workspace_id.
  • Sandbox is currently available in cn-beijing only and requires prior SLR authorization.
  • Global --timeout limits HTTP requests and total template-build polling; --instance-timeout maps to the Sandbox API lifetime field.

Examples

bl sandbox pause --sandbox-id sbx-xxx

bl sandbox pause --sandbox-id sbx-xxx --dry-run --output json

bl sandbox resume

Field Value
Name sandbox resume
Description Resume a Sandbox instance and return connection information
Authentication API Key
Usage bl sandbox resume --sandbox-id <id> [--instance-timeout <seconds>] [--show-credentials]

Flags

Flag Type Required Description
--workspace-id <id> string no Workspace ID for the Sandbox endpoint (or set BAILIAN_WORKSPACE_ID)
--sandbox-id <id> string yes Sandbox instance ID
--body <json|@path> string no JSON request body, inline or loaded from an @file path; explicit flags override it
--instance-timeout <seconds> number no Sandbox lifetime after this operation (300-604800 seconds)
--show-credentials switch no Print envd and traffic access tokens instead of redacting them
--api-key <key> string no API key
--base-url <url> string no API base URL

Notes

  • Auth: uses a Bailian API Key as an Authorization Bearer token; no E2B key is sent.
  • The workspace is resolved from --workspace-id, BAILIAN_WORKSPACE_ID, then config workspace_id.
  • Sandbox is currently available in cn-beijing only and requires prior SLR authorization.
  • Global --timeout limits HTTP requests and total template-build polling; --instance-timeout maps to the Sandbox API lifetime field.

Examples

bl sandbox resume --sandbox-id sbx-xxx --instance-timeout 3600

bl sandbox resume --sandbox-id sbx-xxx --show-credentials --output json

bl sandbox template build-status

Field Value
Name sandbox template build-status
Description Get Sandbox template build status
Authentication API Key
Usage bl sandbox template build-status --template-id <id> --build-id <id>

Flags

Flag Type Required Description
--workspace-id <id> string no Workspace ID for the Sandbox endpoint (or set BAILIAN_WORKSPACE_ID)
--template-id <id> string yes Sandbox template ID
--build-id <id> string yes Template build ID
--api-key <key> string no API key
--base-url <url> string no API base URL

Notes

  • Auth: uses a Bailian API Key as an Authorization Bearer token; no E2B key is sent.
  • The workspace is resolved from --workspace-id, BAILIAN_WORKSPACE_ID, then config workspace_id.
  • Sandbox is currently available in cn-beijing only and requires prior SLR authorization.
  • Global --timeout limits HTTP requests and total template-build polling; --instance-timeout maps to the Sandbox API lifetime field.

Examples

bl sandbox template build-status --template-id tpl-xxx --build-id build-xxx

bl sandbox template build-status --template-id tpl-xxx --build-id build-xxx --output json

bl sandbox template create

Field Value
Name sandbox template create
Description Create a Sandbox template
Authentication API Key
Usage bl sandbox template create (--name <name> --cpu-count <cores> --memory-mb <mb> | --body <json|@path>) [flags]

Flags

Flag Type Required Description
--workspace-id <id> string no Workspace ID for the Sandbox endpoint (or set BAILIAN_WORKSPACE_ID)
--body <json|@path> string no JSON request body, inline or loaded from an @file path; explicit flags override it
--name <name> string no Template name
--cpu-count <cores> number no vCPU count
--memory-mb <mb> number no Memory in MB
--from-image <image> string no Base image identifier
--image-name <name> string no Base image display name
--env <key=value> array no Template environment variable; repeat for multiple values
--allow-out <address> array no Outbound allow-list entry; repeat for multiple values
--deny-out <address> array no Outbound deny-list entry; repeat for multiple values
--auto-pause-time <seconds> number no Automatically pause after 300-604800 seconds
--max-running-time <seconds> number no Maximum running lifetime in seconds (300-604800)
--description <text> string no Template description
--tag <tag> array no E2B tag; repeat for multiple values
--alias <alias> string no E2B template alias
--async switch no Return the submitted templateID/buildID immediately without polling
--poll-interval <seconds> number no Template build polling interval (default: 5 seconds)
--api-key <key> string no API key
--base-url <url> string no API base URL

Notes

  • Auth: uses a Bailian API Key as an Authorization Bearer token; no E2B key is sent.
  • The workspace is resolved from --workspace-id, BAILIAN_WORKSPACE_ID, then config workspace_id.
  • Sandbox is currently available in cn-beijing only and requires prior SLR authorization.
  • Global --timeout limits HTTP requests and total template-build polling; --instance-timeout maps to the Sandbox API lifetime field.
  • File mounts and other complete nested structures can be supplied through --body.
  • By default the command waits for build status ready; --async returns the submitted build immediately.

Examples

bl sandbox template create --name python --cpu-count 1 --memory-mb 2048

bl sandbox template create --body @template.json --async --output json

bl sandbox template create --name browser --cpu-count 4 --memory-mb 8192 --dry-run --output json

bl sandbox template delete

Field Value
Name sandbox template delete
Description Delete a Sandbox template
Authentication API Key
Usage bl sandbox template delete --template-id <id>
Risk high
Risk message This permanently deletes the Sandbox template and cannot be undone.

Agent safety: Never add --yes automatically. On type="requires_confirmation", stop and ask for explicit user confirmation of the same action and scope.

Flags

Flag Type Required Description
--workspace-id <id> string no Workspace ID for the Sandbox endpoint (or set BAILIAN_WORKSPACE_ID)
--template-id <id> string yes Sandbox template ID
--yes switch no Confirm this high-risk operation
--api-key <key> string no API key
--base-url <url> string no API base URL

Notes

  • Auth: uses a Bailian API Key as an Authorization Bearer token; no E2B key is sent.
  • The workspace is resolved from --workspace-id, BAILIAN_WORKSPACE_ID, then config workspace_id.
  • Sandbox is currently available in cn-beijing only and requires prior SLR authorization.
  • Global --timeout limits HTTP requests and total template-build polling; --instance-timeout maps to the Sandbox API lifetime field.
  • The server rejects deletion while running or paused instances still use the template.

Examples

bl sandbox template delete --template-id tpl-xxx --dry-run

# Only after explicit user confirmation:
bl sandbox template delete --template-id tpl-xxx --yes

bl sandbox template get

Field Value
Name sandbox template get
Description Get Sandbox template details
Authentication API Key
Usage bl sandbox template get --template-id <id>

Flags

Flag Type Required Description
--workspace-id <id> string no Workspace ID for the Sandbox endpoint (or set BAILIAN_WORKSPACE_ID)
--template-id <id> string yes Sandbox template ID
--api-key <key> string no API key
--base-url <url> string no API base URL

Notes

  • Auth: uses a Bailian API Key as an Authorization Bearer token; no E2B key is sent.
  • The workspace is resolved from --workspace-id, BAILIAN_WORKSPACE_ID, then config workspace_id.
  • Sandbox is currently available in cn-beijing only and requires prior SLR authorization.
  • Global --timeout limits HTTP requests and total template-build polling; --instance-timeout maps to the Sandbox API lifetime field.

Examples

bl sandbox template get --template-id tpl-xxx

bl sandbox template get --template-id tpl-xxx --output json

bl sandbox template list

Field Value
Name sandbox template list
Description List Sandbox templates
Authentication API Key
Usage bl sandbox template list [--limit <n>] [--cursor <cursor>]

Flags

Flag Type Required Description
--workspace-id <id> string no Workspace ID for the Sandbox endpoint (or set BAILIAN_WORKSPACE_ID)
--limit <n> number no Maximum results (1-100)
--cursor <cursor> string no Server-side pagination cursor
--api-key <key> string no API key
--base-url <url> string no API base URL

Notes

  • Auth: uses a Bailian API Key as an Authorization Bearer token; no E2B key is sent.
  • The workspace is resolved from --workspace-id, BAILIAN_WORKSPACE_ID, then config workspace_id.
  • Sandbox is currently available in cn-beijing only and requires prior SLR authorization.
  • Global --timeout limits HTTP requests and total template-build polling; --instance-timeout maps to the Sandbox API lifetime field.
  • The API response does not expose a next cursor, so automatic --all pagination is unavailable.

Examples

bl sandbox template list

bl sandbox template list --limit 100 --output json

bl sandbox template update

Field Value
Name sandbox template update
Description Update a Sandbox template
Authentication API Key
Usage bl sandbox template update --template-id <id> (--body <json|@path> | [fields])

Flags

Flag Type Required Description
--workspace-id <id> string no Workspace ID for the Sandbox endpoint (or set BAILIAN_WORKSPACE_ID)
--template-id <id> string yes Sandbox template ID
--body <json|@path> string no JSON request body, inline or loaded from an @file path; explicit flags override it
--name <name> string no Template name
--cpu-count <cores> number no vCPU count
--memory-mb <mb> number no Memory in MB
--from-image <image> string no Base image identifier
--image-name <name> string no Base image display name
--env <key=value> array no Template environment variable; repeat for multiple values
--allow-out <address> array no Outbound allow-list entry; repeat for multiple values
--deny-out <address> array no Outbound deny-list entry; repeat for multiple values
--auto-pause-time <seconds> number no Automatically pause after 300-604800 seconds
--max-running-time <seconds> number no Maximum running lifetime in seconds (300-604800)
--description <text> string no Template description
--async switch no Return the submitted templateID/buildID immediately without polling
--poll-interval <seconds> number no Template build polling interval (default: 5 seconds)
--api-key <key> string no API key
--base-url <url> string no API base URL

Notes

  • Auth: uses a Bailian API Key as an Authorization Bearer token; no E2B key is sent.
  • The workspace is resolved from --workspace-id, BAILIAN_WORKSPACE_ID, then config workspace_id.
  • Sandbox is currently available in cn-beijing only and requires prior SLR authorization.
  • Global --timeout limits HTTP requests and total template-build polling; --instance-timeout maps to the Sandbox API lifetime field.
  • Supplying envConfig or --env replaces the template's complete environment map.
  • By default the command waits for build status ready; --async returns the submitted build immediately.

Examples

bl sandbox template update --template-id tpl-xxx --cpu-count 4 --memory-mb 8192

bl sandbox template update --template-id tpl-xxx --body @template-update.json --async --output json

bl sandbox template update --template-id tpl-xxx --description updated --dry-run --output json
Reference in New Issue View Git Blame Copy Permalink