Codex LSP for VS Code
Language support for .codex prompt files in VS Code.
Codex LSP understands the prompt syntax you use with Codex: @file
references, /slash commands, and $skill mentions. It provides autocomplete
and diagnostics directly inside .codex files.
Features
- Autocomplete for
@file references.
- Autocomplete for
/slash commands.
- Autocomplete for
$skill mentions.
- Diagnostics for common
.codex prompt issues.
- Bundled language server: no separate
codex-lsp installation required.
Getting started
- Install this extension from the VS Code Marketplace.
- Open or create a file ending in
.codex.
- Type
@, /, or $ to trigger completions.
The extension includes codex-lsp server binaries for macOS, Linux, and
Windows:
- macOS Apple Silicon and Intel
- Linux x64 and arm64
- Windows x64 and arm64
Configuration
Most users do not need any configuration.
For development or debugging, you can force the extension to use a custom server
binary:
{
"codexLsp.serverPath": "/absolute/path/to/codex-lsp"
}
If this setting is present, it overrides the bundled server. Remove it to return
to the built-in server.
Troubleshooting
If completions do not appear:
- Confirm the file extension is
.codex.
- Reload the VS Code window.
- Check whether
codexLsp.serverPath is set and points to a valid executable.
- Open the VS Code output panel and look for the Codex LSP output channel.
Local development
For extension development:
cd editors/vscode
npm install
npm run compile
code .
Press F5 in VS Code to start an Extension Development Host.
Building the universal VSIX locally requires Zig and cargo-zigbuild:
cargo install cargo-zigbuild --locked
vsce package