11# Installing Lumen for Codex
22
33Enable Lumen in Codex with native skill discovery plus a registered MCP
4- server.
4+ server and Codex startup hooks .
55
66## Prerequisites
77
@@ -16,56 +16,77 @@ server.
1616 git clone https://github.com/ory/lumen.git " $CODEX_HOME /lumen"
1717 ```
1818
19- 2 . Create the skills symlink :
19+ 2 . Run the Codex installer :
2020 ``` bash
21- mkdir -p " $HOME /.agents/skills"
22- ln -s " $CODEX_HOME /lumen/skills" " $HOME /.agents/skills/lumen"
21+ " $CODEX_HOME /lumen/scripts/run" codex install
2322 ```
2423
25- 3 . Register the MCP server:
26- ``` bash
27- codex mcp add lumen -- " $CODEX_HOME /lumen/scripts/run" stdio
28- ```
24+ 3 . Restart Codex.
2925
30- 4 . Restart Codex.
26+ The installer enables Codex hooks in ` config.toml ` , registers the ` lumen ` MCP
27+ server, links or copies the shared Lumen skills into Codex's user skill
28+ directory, and installs a user-level Codex ` SessionStart ` hook. That hook runs
29+ on startup, resume, and clear events and reuses Lumen's background indexer to
30+ proactively warm the project index.
3131
3232## Windows (PowerShell)
3333
3434``` powershell
3535$codexHome = if ($env:CODEX_HOME) { $env:CODEX_HOME } else { Join-Path $env:USERPROFILE ".codex" }
3636git clone https://github.com/ory/lumen.git "$codexHome\lumen"
37- New-Item -ItemType Directory -Force -Path "$env:USERPROFILE\.agents\skills" | Out-Null
38- cmd /c mklink /J "$env:USERPROFILE\.agents\skills\lumen" "$codexHome\lumen\skills"
39- codex mcp add lumen -- "$codexHome\lumen\scripts\run.cmd" stdio
37+ cmd /c "$codexHome\lumen\scripts\run.cmd" codex install
4038```
4139
40+ Restart Codex after the installer completes.
41+
4242## Migrating from the old repo-local plugin
4343
4444If you previously used the repo-local Codex marketplace package:
4545
46461 . Remove the old plugin from Codex's plugin UI.
47- 2 . Register the MCP server with ` codex mcp add ` as above.
48- 3 . Create the ` ~/.agents/skills/lumen ` symlink.
49- 4 . Restart Codex.
47+ 2 . Run ` "$CODEX_HOME/lumen/scripts/run" codex install ` .
48+ 3 . Restart Codex.
49+
50+ If you previously hand-edited Codex MCP or hook configuration, remove stale
51+ manual entries after confirming the installer-managed configuration works. The
52+ installer owns the user-level Codex MCP registration, skill link or copy, and
53+ ` hooks.json ` ` SessionStart ` entry for Lumen.
5054
5155## Verify
5256
5357``` bash
58+ " ${CODEX_HOME:- $HOME / .codex} /lumen/scripts/run" codex doctor
5459codex mcp get lumen
55- ls -la " $HOME /.agents/skills/lumen"
5660```
5761
5862## Updating
5963
6064``` bash
6165cd " ${CODEX_HOME:- $HOME / .codex} /lumen" && git pull
66+ " ${CODEX_HOME:- $HOME / .codex} /lumen/scripts/run" codex install
6267```
6368
6469## Uninstalling
6570
6671``` bash
6772codex mcp remove lumen
68- rm " $HOME /.agents/skills/lumen"
73+ skills=" $HOME /.agents/skills/lumen"
74+ if [ -L " $skills " ]; then
75+ target=" $( readlink " $skills " ) "
76+ case " $target " in
77+ * /lumen/skills) rm " $skills " ;;
78+ * ) echo " Refusing to remove non-Lumen skills link: $skills -> $target " >&2 ;;
79+ esac
80+ elif [ -f " $skills /.lumen-skills-source" ]; then
81+ rm -rf " $skills "
82+ else
83+ echo " No installer-managed Lumen skills path found at $skills " >&2
84+ fi
6985```
7086
71- Optionally delete the clone: ` rm -rf "${CODEX_HOME:-$HOME/.codex}/lumen" ` .
87+ Remove the Lumen ` SessionStart ` group from
88+ ` ${CODEX_HOME:-$HOME/.codex}/hooks.json ` if you want to remove the startup hook
89+ as well. If you no longer use any Codex hooks, you can also remove
90+ ` codex_hooks = true ` from the ` [features] ` table in
91+ ` ${CODEX_HOME:-$HOME/.codex}/config.toml ` . Optionally delete the clone:
92+ ` rm -rf "${CODEX_HOME:-$HOME/.codex}/lumen" ` .
0 commit comments