Skip to content

docs: keep example commands in their own working directories #45

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
samzong merged 1 commit into from
Oct 2, 2026
Merged

docs: keep example commands in their own working directories #45

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
21 changes: 15 additions & 6 deletions examples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,26 @@ The examples show the smallest installer primitive integration: pass `appId`, `s

The temporary `HOME` wrapper keeps the demos from writing to your real user skill directory and provides a Codex detection path for the SDK's default auto agent selection.

Run these commands from the repository root. Each directory change runs in a
subshell so the next example also starts from the root.

```bash
tmp="$(mktemp -d)" && mkdir -p "$tmp/.codex" && HOME="$tmp" pnpm --dir examples/ts install-skill

cd examples/go
tmp="$(mktemp -d)" && mkdir -p "$tmp/.codex" && HOME="$tmp" go run .
(
cd examples/go &&
tmp="$(mktemp -d)" && mkdir -p "$tmp/.codex" && HOME="$tmp" go run .
)

cd examples/rust
tmp="$(mktemp -d)" && mkdir -p "$tmp/.codex" && CARGO_HOME="${CARGO_HOME:-$HOME/.cargo}" RUSTUP_HOME="${RUSTUP_HOME:-$HOME/.rustup}" HOME="$tmp" cargo run --quiet
(
cd examples/rust &&
tmp="$(mktemp -d)" && mkdir -p "$tmp/.codex" && CARGO_HOME="${CARGO_HOME:-$HOME/.cargo}" RUSTUP_HOME="${RUSTUP_HOME:-$HOME/.rustup}" HOME="$tmp" cargo run --quiet
)

cd examples/python
tmp="$(mktemp -d)" && mkdir -p "$tmp/.codex" && HOME="$tmp" uv run python main.py
(
cd examples/python &&
tmp="$(mktemp -d)" && mkdir -p "$tmp/.codex" && HOME="$tmp" uv run python main.py
)
```

Production CLIs should call the workflow API before installing so explicit agents, `*`, `--yes`, TTY, non-TTY, summary confirmation, scope prompting, and cancellation behavior stay aligned across languages.
Loading