feat(app): add app --instance flag, deprecate app-instance command#21
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR consolidates Codex Desktop launching into a single app command with an opt-in --instance mode, while keeping app-instance as a deprecated compatibility alias. It updates the CLI parser, docs, and tests, and bumps the release to 0.5.0.
Changes:
- Add
codex-profile app <profile> --instance [--rebuild] [workspace]and routeapp-instancethrough the same code path as a deprecated alias. - Update documentation and site content to lead with
app --instanceand demoteapp-instance. - Add test coverage for
--instance, theapp-instancealias, and--rebuildrequiring--instance, plus bump version to 0.5.0 across release surfaces.
Reviewed changes
Copilot reviewed 9 out of 10 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
bin/codex-profile |
Implements app --instance flag parsing, routes deprecated app-instance alias, updates help text and shell completions. |
test/codex-profile-test.sh |
Adds tests for app --instance, app-instance alias behavior, and --rebuild validation; updates completion expectations. |
README.md |
Updates primary usage examples and command reference to app --instance and documents the deprecated alias. |
SECURITY.md |
Updates isolation/security wording to reference app --instance instead of app-instance. |
CHANGELOG.md |
Adds 0.5.0 entry documenting the change and deprecation. |
package.json |
Bumps package version to 0.5.0. |
docs/index.html |
Bumps softwareVersion and updates site copy/examples to app --instance. |
docs/llms.txt |
Updates AI-facing quickstart example to app --instance. |
docs/geo-measurement.md |
Updates GEO Q/A answer to reference app --instance. |
AGENTS.md |
Updates agent guidance examples to use app --instance. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Collapse the two co-equal Desktop launch commands into one verb. `app` stays the default single-app switcher (stock, notarized Codex.app), and parallel launch moves behind an opt-in `--instance` flag; `--rebuild` is valid only together with `--instance`. `app-instance` remains as a hidden, deprecated back-compat alias that forwards to `app --instance`, so existing scripts and muscle memory keep working. Keeps the `--instance` name consistent with `logs --instance` and CODEX_PROFILE_APP_INSTANCE_ROOT. Updates help text, bash/zsh/fish completions, and docs (README, SECURITY, AGENTS, llms.txt, index.html, geo-measurement) to lead with `app`. Adds tests for the flag path, the alias, and the --rebuild-requires-instance guard. Bump version to 0.5.0. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
f7c6e1e to
38f8910
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Collapses the two co-equal Codex Desktop launch commands into one verb with an opt-in flag:
codex-profile app <profile>— unchanged default: quit + relaunch the stock, notarizedCodex.app(one window).codex-profile app <profile> --instance [--rebuild]— the parallel clone path (experimental, macOS).--rebuilderrors unless combined with--instance.codex-profile app-instance …— kept as a hidden, deprecated back-compat alias that forwards toapp --instance(same code path). Existing scripts/muscle memory keep working.Why a flag, not two commands
"Launch alongside" is a modifier on "launch Codex for a profile," not a different operation — matching how GUI apps expose parallel/multi-profile launch (Firefox
-no-remote, Chrome/VS Code--user-data-dir). Keeping the name--instancestays consistent with the existinglogs --instanceandCODEX_PROFILE_APP_INSTANCE_ROOT, and demoting parallel to opt-in keeps the safe/cheap/notarized path as the default.Changes
bin/codex-profile: parser split intorun_app_switch/run_app_instance; alias; help text; macOS-only messaging; bash/zsh/fish completions (dropapp-instancefrom advertised lists, add--instance/--rebuild, keep alias completable).app, present--instanceas opt-in, demoteapp-instance:README.md,SECURITY.md,AGENTS.md,docs/llms.txt,docs/index.html,docs/geo-measurement.md.CHANGELOG.md: 0.5.0 entry (Changed + Deprecated).package.json,bin/codex-profile, anddocs/index.html(drift guard enforces all three match).Tests
make lintclean; shell suite 54/54; geo-site + npm-package smoke tests pass.app --instancelaunch,app-instancealias still works,--rebuildwithout--instanceerrors.Release (manual, after merge)
Tag
v0.5.0to trigger the npm publish workflow; check the Homebrew tap picks up 0.5.0.🤖 Generated with Claude Code