@@ -10,6 +10,9 @@ and Linux, with optional `direnv`, VS Code, and macOS Finder integration.
1010
1111Developed at the [ Fritsche Lab] ( https://fritschelab.org/ ) , University of Michigan.
1212
13+ ** New here?** Follow [ Installation] ( INSTALLATION.md ) for the complete macOS or
14+ Linux setup, from prerequisites through your first identity and project.
15+
1316## One account choice per project
1417
1518Each project's ` .envrc ` selects an identity and its ` CODEX_HOME ` . The account,
@@ -68,13 +71,8 @@ and session history. Each VS Code window shows the identity name, with a
6871separate VS Code user-data directory per identity. In a configured project's
6972terminal, start the selected context with ` codex-home run ` .
7073
71- On macOS, the helper opens a named editor copy: hover over its running Dock
72- icon to read ` VS Code - NAME ` . Projects using the same identity reuse its
73- instance. In Finder, use ** Quick Actions > Open in Codex Project** for a
74- configured folder. File managers with folder ** Open With** menus can use the
75- matching ** VS Code - NAME** handler. You can also use ` codex-home ` ; do not pin or directly open the
76- generated editor copy, which needs the helper's launch environment. See
77- [ macOS Dock names] ( docs/projects-vscode.md#macos-dock-names ) .
74+ On macOS, the helper also gives each identity a [ named Dock icon] ( docs/projects-vscode.md#macos-dock-names )
75+ and offers optional [ Finder integration] ( docs/macos-open-with.md ) .
7876
7977The CLI launcher keeps ** [ CODEX: NAME] ** in the terminal tab/window title.
8078
@@ -85,44 +83,52 @@ sandbox. Keep credentials and identity homes private. See the
8583
8684## Get started
8785
88- [ Install the prerequisites and clone the repository ] ( INSTALLATION.md ) .
89- The helper runs without administrator rights; installing some prerequisites
90- may require them.
86+ If the prerequisites are installed and the clone is ready, use this quick path .
87+ Otherwise, begin with [ Installation ] ( INSTALLATION.md ) . The helper runs without
88+ administrator rights; installing some prerequisites may require them.
9189
9290From the clone directory, create a ChatGPT identity and sign in:
9391
9492``` bash
9593./bin/codex-home create-subscription personal
9694./bin/codex-home login personal
95+ ```
96+
97+ Check the intended account and workspace in the browser during sign-in. Then
98+ check the CLI authentication method and launch a session:
99+
100+ ``` bash
101+ ./bin/codex-home run personal login status
97102./bin/codex-home run personal
98103```
99104
105+ In the CLI, use ` /status ` to inspect the active model and session configuration.
106+ The identity name is a local label; see [ verification for CLI and VS Code] ( docs/commands.md#check-the-selected-identity ) .
107+
100108For an API key, follow the [ API provider] ( docs/api-providers.md ) or
101109[ U-M GPT] ( docs/umgpt.md ) guide. Each guide covers access, billing, and a test of
102110Codex tool calls with your selected model.
103111
104- U-M GPT model recommendations are kept in the visible, version-controlled
105- file [ ` config/umgpt-models.toml ` ] ( config/umgpt-models.toml ) . Users can keep
106- different local defaults in ` ~/.codex-homes/umgpt-models.toml ` ; run
107- ` codex-home umgpt-defaults ` to compare them. Neither file is a model catalog:
108- ` codex-home models umgpt ` and ` codex-home models umgpt-low ` query the gateway's
109- current scoped model lists. The dated
110- [ model snapshot] ( docs/umgpt-models-snapshot.md ) records one credential's
111- observed catalog for review only; it is not used at runtime or an approval
112- list.
113-
114- To use your identity for a project in VS Code:
112+ After exiting Codex, use your identity for a project in VS Code:
115113
116114``` bash
117115./bin/codex-home project personal " /path/to/project"
116+ ```
117+
118+ Review the generated ` .envrc ` and ` .vscode/<folder-name>.code-workspace ` .
119+ The ` .envrc ` contains executable shell code and local paths. Then approve it
120+ and launch:
121+
122+ ``` bash
118123direnv allow " /path/to/project"
119124./bin/codex-home vscode personal " /path/to/project"
120125```
121126
122- Review ` .envrc ` before running ` direnv allow ` : it contains executable shell
123- code and local paths. The helper preserves existing project files and uses
124- local Git exclusions for the files it generates. Start a new Codex chat and
125- check ` /status ` to confirm the account and provider.
127+ The helper preserves existing project files and uses local Git exclusions for
128+ the files it generates. Start a new Codex chat and [ verify the extension's
129+ account and selected model] ( docs/commands.md#check-the-selected-identity ) .
130+ See [ Projects and VS Code] ( docs/projects-vscode.md ) for terminal use and
131+ existing project configuration.
126132
127133For right-click access on macOS, run ` ./bin/install-macos-open-with ` , then
128134choose ** Quick Actions > Open in Codex Project** on a project folder. The
0 commit comments