Skip to content

docs: explain global Codex setup #83

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
alxxjohn merged 1 commit into from
Jul 26, 2026
Merged

docs: explain global Codex setup #83

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
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,16 @@ Choose the coding agent you use. This lets it use szr while it works:
szr install codex --global
```

This is a one-time setup for all existing and future repositories. It adds the szr guidance to `$CODEX_HOME/AGENTS.md` (normally `~/.codex/AGENTS.md`), so you do not need to install szr separately in every repository or add an `AGENTS.md` file to each one. Restart Codex after installing it.

After downloading a newer szr release, refresh the installed binary and global guidance:

```bash
szr self install
szr self doctor
szr install codex --global
```

Use `szr install codex` for only the current repository; szr finds the nearest Git root when run from a nested folder. Use `szr install codex --root <path>` to select a repository explicitly. Other options are `szr install claude-code`, `szr install cursor`, or `szr install gemini`. Use `szr uninstall <tool>` to remove an integration. The [user guide](docs/USER_GUIDE.md#ai-tool-integrations) explains what each setup changes.

## 3. Use szr
Expand Down
Loading