obsidian-plugin/rait-09_obsidian-agent-client
1
0
Fork 0
mirror of https://github.com/rait-09/obsidian-agent-client.git synced 2026-07-22 16:30:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
rait-09_obsidian-agent-client/docs/agent-setup/codex.md
RAIT-09 8bbe40a2a3 Add VitePress documentation site for Agent Client 
Introduces a full documentation site under docs/ using VitePress, including configuration, custom theme, setup guides for supported agents (Claude Code, Codex, Gemini CLI, custom agents), usage instructions, FAQ, troubleshooting, and images. Updates .gitignore and .prettierignore to exclude VitePress build output and docs. Also updates package.json and eslint config for documentation support.
2025-12-14 01:53:46 +09:00

1.7 KiB
Raw Blame History

Codex Setup

Codex is OpenAI's AI coding assistant. You can use it with either an API key or by logging in with your OpenAI account.

Install and Configure

  1. Install codex-acp:
npm install -g @zed-industries/codex-acp
  1. Find the installation path:

::: code-group

which codex-acp
# Example output: /usr/local/bin/codex-acp

where.exe codex-acp
# Example output: C:\Users\Username\AppData\Roaming\npm\codex-acp.cmd

:::

  1. Open Settings → Agent Client and set the Codex path to the path found above.

Authentication

Choose one of the following methods:

Option A: API Key

  1. Get your API key from OpenAI Platform
  2. Enter the API key in Settings → Agent Client → Codex → API key

Option B: Account Login

If you have a ChatGPT subscription and prefer not to use an API key, you can log in with your OpenAI account.

::: warning Important This requires installing Codex CLI separately. The CLI creates the login session that the plugin uses. :::

  1. Install Codex CLI:
npm install -g @openai/codex
  1. Login via CLI:
codex

Follow the prompts to authenticate with your OpenAI account.

  1. In Settings → Agent Client, leave the API key field empty.

::: tip The ChatGPT app uses a different authentication system. Having ChatGPT running does not authenticate the plugin — you must log in via the CLI. :::

Verify Setup

  1. Click the robot icon in the ribbon or use the command palette: "Open agent chat"
  2. Switch to Codex from the agent dropdown in the chat header
  3. Try sending a message to verify the connection

Having issues? See Troubleshooting.