Skip to content

docs(#4649): replace stale EnsureGateway references with CheckGateway #4654

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rh-hemartin merged 1 commit into from
Jul 14, 2026
Merged

docs(#4649): replace stale EnsureGateway references with CheckGateway #4654

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/ADRs/0030-openshell-sandbox-interaction-model.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ HTTP CONNECT endpoint — no direct TCP listener on the sandbox. Rsync over SSH
extracts the modified target repo with `--no-links` (prevent symlink-based
sandbox escape) and `--exclude .git/hooks/` (prevent injected executables).

**Gateway: start once, reuse (Option A).** `EnsureGateway()` is idempotent. The
**Gateway: start once, reuse (Option A).** `EnsureGateway()` (renamed to `CheckGateway()` in PR #4533) is idempotent. The
gateway persists across sandbox invocations within the same runner job.

**Sandbox lifecycle** follows a fixed sequence: create (`openshell sandbox create
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/dev/cli-internals.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -348,7 +348,7 @@ Vendoring commit messages use title + body (upload and stale delete). `github st
│ └──────┬───────────┘ │
│ ▼ │
│ ┌──────────────────┐ │
│ │ EnsureGateway() │ Start/verify gateway service │
│ │ CheckGateway() │ Start/verify gateway service │
│ └──────┬───────────┘ │
│ ▼ │
│ ┌──────────────────┐ │
Expand Down Expand Up @@ -455,7 +455,7 @@ details, see [Agent runtimes](../../runtimes.md).
| Operation | CLI Command | Purpose |
|-----------|------------|---------|
| `EnsureAvailable()` | Check `openshell` binary | Verify runtime available |
| `EnsureGateway()` | `openshell gateway ...` | Start inference gateway |
| `CheckGateway()` | `openshell gateway ...` | Start inference gateway |
| `EnsureProvider()` | `openshell provider ...` | Register model provider (bare-key form) |
| `Create()` | `openshell sandbox create --image ...` | Spin up container |
| `Exec()` | `openshell sandbox exec ...` | Run command in sandbox |
Expand Down
2 changes: 1 addition & 1 deletion docs/superpowers/specs/2026-05-06-openshell-native-sandbox-transport-design.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ These `exec.Command` calls target the `openshell` binary directly (not SSH/SCP/r

- `EnsureProvider()` — `openshell provider create`
- `EnsureAvailable()` — `exec.LookPath("openshell")`
- `EnsureGateway()` — `openshell gateway info/start`
- `CheckGateway()` — `openshell gateway info/start`
- `Create()` — `openshell sandbox create`
- `Delete()` — `openshell sandbox delete`
- `CollectLogs()` — `openshell logs`
Expand Down
Loading