Skip to content

docs(cli): add sandbox command usage examples to CLI README #1289

@luojiyin1987

Description

@luojiyin1987

Summary

The CLI README currently links to the docs, but it does not include concrete examples for common e2b sandbox workflows.

Problem

Users can discover the commands from --help, but common usage patterns are not documented in one place. This makes it harder to find examples for:

  • creating and detaching sandboxes
  • listing sandboxes with state and metadata filters
  • connecting to a running sandbox
  • streaming logs and metrics
  • running commands with --, environment variables, and piped stdin

Proposed change

Add a Common sandbox commands section to packages/cli/README.md with short examples covering the workflows above.

Why this helps

  • keeps detailed usage examples in documentation instead of expanding code-level help text
  • reduces ambiguity around e2b sandbox exec argument separation
  • gives users a fast path for the most common sandbox operations

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions