Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ body:
id: extension_version
attributes:
label: Extension version
placeholder: 0.1.8
placeholder: Copy the installed version from the Extensions view.
validations:
required: true
- type: input
Expand Down
Binary file added .github/social-preview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
82 changes: 82 additions & 0 deletions .github/social-preview.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 20 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,26 @@

## [Unreleased]

## 0.1.10 - 2026-08-08

### Fixed

- Recognized PowerShell commands that use the `&` call operator with a quoted Codex executable path, while continuing to send the configured command to the shell unchanged.

### Added

- Added a deterministic GitHub social preview and regression checks for its dimensions, affiliation wording, and repository-only packaging.

### Changed

- Documented shell-specific Windows command examples and explicit signed-tag creation and verification steps for future releases.
- Refined the GitHub and Marketplace presentation with clearer installation paths, a concise trust model, an explicit compatibility matrix, and less prominent cross-promotion.
- Removed unverified Cursor and Windsurf compatibility claims from Marketplace metadata.

### Security

- Updated transitive development dependencies to resolve the current `fast-uri`, `js-yaml`, and `undici` advisories in the packaging toolchain.

## 0.1.9 - 2026-08-01

### Fixed
Expand Down
3 changes: 2 additions & 1 deletion CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,6 @@ authors:
- family-names: Gasperini
given-names: Michael
url: "https://github.com/TheStreamCode/codex-cli-launcher"
version: "0.1.9"
version: "0.1.10"
date-released: "2026-08-08"
license: MIT
88 changes: 57 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,43 +5,65 @@
[![Open VSX](https://img.shields.io/open-vsx/v/mikesoft/vscode-codex-cli-launcher?label=Open%20VSX&color=a60ee5)](https://open-vsx.org/extension/mikesoft/vscode-codex-cli-launcher)
[![CI](https://github.com/TheStreamCode/codex-cli-launcher/actions/workflows/ci.yml/badge.svg)](https://github.com/TheStreamCode/codex-cli-launcher/actions/workflows/ci.yml)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
[![Sponsor](https://img.shields.io/badge/Sponsor-TheStreamCode-ea4aaa?logo=githubsponsors&logoColor=white)](https://github.com/sponsors/TheStreamCode)

Codex CLI Launcher is an unofficial VS Code extension that opens OpenAI Codex CLI in a new side terminal directly from the editor toolbar.
Launch OpenAI Codex CLI in a fresh side terminal directly from the VS Code editor toolbar.

Works on Windows, macOS, and Linux where Codex CLI is available to the integrated terminal.
[**Install from Visual Studio Marketplace**](https://marketplace.visualstudio.com/items?itemName=mikesoft.vscode-codex-cli-launcher) · [**Install from Open VSX**](https://open-vsx.org/extension/mikesoft/vscode-codex-cli-launcher)

Current release: `0.1.9`.
Latest GitHub release: [`v0.1.10`](https://github.com/TheStreamCode/codex-cli-launcher/releases/tag/v0.1.10)

> **Disclaimer**
> This extension is unofficial and is not affiliated with, endorsed by, sponsored by, or approved by OpenAI. "OpenAI", "Codex", and related names are trademarks of their respective owners.
Codex CLI Launcher is a small, unofficial VS Code extension for developers who already use Codex CLI and want a predictable one-click launcher inside the editor. It works on Windows, macOS, and Linux wherever `codex` is available to the integrated terminal.

> **✨ Want one launcher for every agent?** Try **[Super CLI](https://marketplace.visualstudio.com/items?itemName=mikesoft.vscode-super-cli)** — a single sidebar that launches Claude Code, Codex, Copilot, Cursor, Grok, Kilo, Antigravity, OpenCode, and more. Install this launcher for Codex alone, or Super CLI for the whole set.
> **Unofficial project:** This extension is not affiliated with, endorsed by, sponsored by, or approved by OpenAI. "OpenAI", "Codex", and related names are trademarks of their respective owners.

## Features

- Adds a launcher button to the editor title area
- Uses local Marketplace and toolbar artwork packaged with the extension
- Opens a fresh terminal beside the active editor on every launch
- Uses the active editor workspace when available, with a fallback to the first open workspace folder
- Runs a configurable Codex CLI command
- Launch Codex CLI from the editor title with one click
- Open a fresh side terminal for every launch instead of reusing existing sessions
- Start in the active editor's workspace, with a predictable fallback for multi-root windows
- Configure the launch command and terminal name without repository-controlled overrides
- Links to the official Codex CLI installation documentation when the default `codex` command is not available
- Supports quoted Windows executable paths
- Supports quoted Windows executable paths, including PowerShell's call operator
- Does not collect telemetry, analytics, or personal data

## Requirements
## Quick Start

- VS Code `^1.103.0`
- Codex CLI available in the integrated terminal environment, or a working custom launch command configured in settings
1. Install Codex CLI using the [official Codex CLI documentation](https://learn.chatgpt.com/docs/codex/cli).
2. Install Codex CLI Launcher from the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=mikesoft.vscode-codex-cli-launcher) or [Open VSX](https://open-vsx.org/extension/mikesoft/vscode-codex-cli-launcher).
3. Open a file in a trusted workspace.
4. Click the launcher button in the editor title.

## Installation
VS Code users can also install the extension from a terminal:

1. Install the extension from the VS Code Marketplace.
2. Install Codex CLI by following the [official Codex CLI installation documentation](https://learn.chatgpt.com/docs/codex/cli).
3. Open any file in VS Code.
4. Click the launcher button in the editor title.
```bash
code --install-extension mikesoft.vscode-codex-cli-launcher
```

Any equivalent install or launch method that makes `codex` available in your terminal also works.
## Trust and Privacy

- The launcher is disabled until the workspace is trusted.
- The CLI command is machine-scoped and cannot be supplied by a repository.
- The extension never downloads Codex CLI, generates installer scripts, or runs package-manager installation commands.
- Shell-output capture is bounded and used only to recognize a missing default `codex` command. Output from custom commands is not read.
- No telemetry, analytics, or personal data is collected.
- All extension artwork is packaged in the VSIX; no external images are loaded at runtime.

See [SECURITY.md](SECURITY.md) and the [architecture documentation](docs/architecture.md) for the maintained trust boundaries.

## Compatibility

| Environment | Status |
| --- | --- |
| VS Code `^1.103.0` | Supported and covered by the minimum-version integration test |
| Windows | Supported and validated in CI |
| Linux | Supported and validated in CI |
| macOS | Supported; not currently included in the CI matrix |
| Other VS Code-compatible editors | May work when they provide the required VS Code APIs, but are not part of the supported test matrix |

## Requirements

- VS Code `^1.103.0`
- Codex CLI available in the integrated terminal environment, or a working custom launch command configured in settings

## Missing CLI

Expand Down Expand Up @@ -74,10 +96,16 @@ Default command:
"codexCliLauncher.cliCommand": "codex"
```

Windows executable path with spaces:
Windows PowerShell executable path with spaces:

```json
"codexCliLauncher.cliCommand": "& \"C:\\Program Files\\OpenAI Codex\\codex.cmd\""
```

Windows Command Prompt executable path with spaces:

```json
"codexCliLauncher.cliCommand": "\"C:\\Users\\You\\AppData\\Roaming\\npm\\codex.cmd\""
"codexCliLauncher.cliCommand": "\"C:\\Program Files\\OpenAI Codex\\codex.cmd\""
```

## Troubleshooting
Expand All @@ -94,18 +122,12 @@ Check `codexCliLauncher.cliCommand` and verify that the same command works in a

### Custom executable path on Windows

Quote executable paths that contain spaces. This is required for commands such as `"C:\Users\You\AppData\Roaming\npm\codex.cmd"`.
Quote executable paths that contain spaces. In PowerShell, use its call operator before the quoted path, for example `& "C:\Program Files\OpenAI Codex\codex.cmd"`. In Command Prompt, use the quoted path directly, for example `"C:\Program Files\OpenAI Codex\codex.cmd"`.

### Multi-root workspaces

The launcher prefers the workspace folder of the active editor. To control where Codex starts in a multi-root window, open a file from the target workspace before clicking the toolbar button.

## Privacy

Codex CLI Launcher does not collect telemetry, analytics, or personal data.

All extension artwork is packaged locally in the VSIX. No external image assets are loaded at runtime.

## Development

Local verification and packaging:
Expand All @@ -131,6 +153,10 @@ Open a [GitHub issue](https://github.com/TheStreamCode/codex-cli-launcher/issues

Financial support for the independent maintainer is available through GitHub Sponsors: [github.com/sponsors/TheStreamCode](https://github.com/sponsors/TheStreamCode).

## Related Project

Need one launcher for multiple coding agents? [Super CLI](https://marketplace.visualstudio.com/items?itemName=mikesoft.vscode-super-cli) provides a single sidebar for Codex, Claude Code, Copilot, Cursor, Grok, Kilo, Antigravity, OpenCode, and other agent CLIs.

## License

Released under the [MIT License](LICENSE).
1 change: 1 addition & 0 deletions docs/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Only `activate` registers on `context.subscriptions`: the two commands and the t

- Workspace files are untrusted input. They must not control `cliCommand` or bypass the workspace-trust gate.
- The configured CLI command is trusted user intent and is sent to the integrated shell. The launcher does not parse arguments into a child process.
- Executable recognition ignores a leading PowerShell call operator only when deciding whether to offer the missing-Codex documentation. The configured command itself is never rewritten.
- Terminal output can contain sensitive data. It is never logged or transmitted, is never read for custom commands, and is bounded while checking for a missing Codex executable.
- Network access is limited to opening the official Codex CLI documentation at the user's request. The extension does not make background requests.

Expand Down
2 changes: 1 addition & 1 deletion docs/releasing.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Releases are maintainer-only and should start from a clean, up-to-date `main` br

1. Commit the release metadata and merge it through the protected branch workflow.
2. Update the local `main` branch to the merge commit, then rerun `npm ci`, `npm run check`, `npm run audit`, and `npm run package` from that clean commit.
3. Create a signed `vX.Y.Z` tag at the verified commit.
3. Create a signed annotated tag with `git tag -s vX.Y.Z -m "vX.Y.Z"`, then verify it with `git tag -v vX.Y.Z` before pushing it.
4. Publish that exact verified VSIX through the maintainer's Visual Studio Marketplace and Open VSX release channels, then attach the same artifact to a GitHub release with concise notes.
5. Confirm the Marketplace, Open VSX, README badges, GitHub release, and repository default branch all report the same version.

Expand Down
22 changes: 11 additions & 11 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
"name": "vscode-codex-cli-launcher",
"private": true,
"displayName": "Codex CLI Launcher — Run OpenAI Codex in a Side Terminal",
"description": "Launch the OpenAI Codex AI coding agent in a side terminal from your editor toolbar. Unofficial; works in VS Code, Cursor & Windsurf on Windows, macOS & Linux.",
"description": "Launch the OpenAI Codex AI coding agent in a side terminal from the VS Code editor toolbar. Unofficial; uses your existing CLI setup on Windows, macOS, and Linux.",
"publisher": "mikesoft",
"version": "0.1.9",
"version": "0.1.10",
"repository": {
"type": "git",
"url": "https://github.com/TheStreamCode/codex-cli-launcher.git"
Expand Down Expand Up @@ -91,7 +91,7 @@
"type": "string",
"scope": "machine",
"default": "codex",
"markdownDescription": "Command used to start Codex CLI. The default is `codex`. On Windows, quote executable paths that contain spaces, for example `\"C:\\Users\\You\\AppData\\Roaming\\npm\\codex.cmd\"`."
"markdownDescription": "Command used to start Codex CLI. The default is `codex`. In PowerShell, prefix a quoted executable path with the call operator, for example `& \"C:\\Program Files\\OpenAI Codex\\codex.cmd\"`. In Command Prompt, use `\"C:\\Program Files\\OpenAI Codex\\codex.cmd\"`."
},
"codexCliLauncher.terminalName": {
"type": "string",
Expand Down
Loading