Skip to content

bug(cli): sandbox help references unpublished Python image #2888

Description

@cwing-nvidia

User Story

As an OpenShell user, I want the CLI's sandbox examples to reference a published community image so that I can successfully follow the built-in help.

Problem Statement

openshell sandbox --help recommends openshell sandbox create --from python, but OpenShell Community does not publish a python sandbox. The CLI consequently treats python as a local directory and fails because it contains no Dockerfile.

Impact / Why This Matters

Users following the built-in example cannot create a sandbox and may misdiagnose the failure as a gateway or container-runtime problem. The current workaround is to discover a valid image name independently or provide the full community base image reference, which defeats the purpose of the built-in quickstart example.

Acceptance Criteria

  • The sandbox help example references a currently published OpenShell Community sandbox.
  • The example can resolve without requiring a local Dockerfile named after the example.
  • Relevant CLI help tests are updated or added if applicable.

Reproduction Steps

  1. Install OpenShell 0.0.111.
  2. Run openshell sandbox --help and observe the openshell sandbox create --from python example.
  3. Run openshell sandbox create --from python.
  4. Observe No Dockerfile found in directory: python.

Environment

  • OpenShell: 0.0.111
  • OS: macOS 26.5.2 on Apple Silicon
  • Runtime, deployment, or integration: Homebrew gateway with Docker through Colima

Logs

Error:   × No Dockerfile found in directory: python

Activity

  1. elezar commented on Aug 24, 2026

    @elezar
    Member

    📋 triage-agent

    Triage Assessment

    Classification: validated-bug

    Summary

    Confirmed that the built-in sandbox help advertises an unavailable python source. The current stable release remains v0.0.111, so the report is not fixed in a newer release.

    Investigation

    crates/openshell-cli/src/main.rs hard-codes openshell sandbox create --from python in SANDBOX_EXAMPLES. The published quickstart and sandbox documentation use the available base community source instead. In crates/openshell-cli/src/run.rs, an existing bare python directory is treated as a local Dockerfile context; without a Dockerfile it returns the reported No Dockerfile found in directory: python error.

    The issue has no prior triage assessment or identified duplicate.

    Suggested fix scope: replace the stale help example with --from base (or another verified published source) and add a focused CLI-help regression assertion so the example remains intentional and discoverable.

    Impact Signals

    • Affected users/scope: Users following the built-in CLI example can fail before creating their first sandbox.
    • Regression: Unknown.
    • Workaround: Use openshell sandbox create --from base or a full image reference.
    • Evidence quality: High: direct current-source inspection and alignment with published documentation.

    Human Decision Required

    Decide whether OpenShell should address this issue. If yes, apply state:accepted, associate it with a roadmap item, or do both, and decide whether the work remains human-owned. If no, close it as not planned and record the rationale.

  2. added
    area:cliCLI-related work
    and removed
    state:triage-neededOpened without agent diagnostics and needs triage
    on Aug 24, 2026
  3. lunarwhite commented on Sep 25, 2026

    @lunarwhite
    Contributor

    This is obsolete as #3386 merged

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions