Skip to content

docs(readme): document setup apply events interface #569

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
ss-o merged 2 commits into from
Sep 20, 2026
Merged

docs(readme): document setup apply events interface #569

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6d16619
docs(readme): document setup apply events interface
ss-o Sep 20, 2026
1aa5634
docs(readme): document cancellation behavior for setup apply events
ss-o Sep 20, 2026
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
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,14 @@ sh -c "$(curl -fsSL get.zshell.dev)" --

> Review the [installer source](https://raw.githubusercontent.com/z-shell/src/main/public/sh/install.sh) and its published [SHA-256 checksum](https://raw.githubusercontent.com/z-shell/src/main/public/checksum.txt) before running a remote installation script.

Automated environments can drive the setup engine directly:

```sh
setup.sh apply --plan DIR --phase checkout|files [--result DIR] [--events DIR]
```

> [!NOTE] Integrator note: the `--events DIR` option is optional, creates a private new absolute directory, publishes atomic numbered `zi-setup-event-v1` event directories with started and terminal state, and human stdout/stderr must not drive automation. Consumers must treat process completion as authoritative and tolerate a missing terminal event if a cancellation signal interrupts event publication itself; staging cleanup and exit 6 still apply.

### 2. Add your first plugins

Add Zi commands to `.zshrc`. This example loads an Oh My Zsh snippet, command suggestions, and fast syntax highlighting:
Expand Down
Loading