Skip to content

Quick Start

Paul edited this page Oct 22, 2026 · 6 revisions

Quick start

1. Install

macOS/Linux:

curl -q -fsSL https://codexify.dev/install.sh | sh

Windows PowerShell:

powershell -ExecutionPolicy ByPass -c "irm https://codexify.dev/install.ps1 | iex"

Open a new terminal, then run:

codexify quickstart

The wizard asks for your project access root, guides you through the native tunnel and runtime key, saves the configuration, and installs or restarts the background service. It prints the current ChatGPT connection instructions. See Installation for manual and source installs and Connecting to ChatGPT for account/tunnel permissions.

2. Connect the plugin

Create and install the custom MCP plugin using the tunnel selected by quickstart. Keep the Codexify service running. Use a regular ChatGPT Chat with the plugin selected; this workflow does not start a Codex or Work agent.

If you configured conversationAuthToken, follow the printed instruction to call setup with the exact ref before other tools. Do not post that value in issues or screenshots.

3. Select a workspace

Use the setup card to choose a project, an existing worktree, a Git URL, or Chat without a project. An ordinary greeting does not select scratch automatically. The worktree checkbox controls whether a new checkout is created.

Start with a read-only request:

Call get_agent_brief and follow the project's instructions.
Explain how this project is organized. Do not change any files.

Then ask for a concrete task:

Fix the failing test, run it again, and show me the diff. Do not commit yet.

Use Switch to another project in setup when needed; the agent must reload the new brief before resuming project work. See Workspace selection and Worktree isolation.

4. Open agent chat

Agent chat is enabled by default. Run this on the service computer:

codexify chat

Open the printed private URL. Do not share it: its fragment is an access credential. The interface lists persisted chats, messages, attachments, receipts, goals, settings, and statistics. The default listener is 127.0.0.1:3120, separate from the MCP tunnel.

Messages default to Queue. When the agent asks for an answer, Return sends your answer immediately. Shift+Return inserts a newline; Cmd+Return on macOS or Ctrl+Return elsewhere uses the other send mode for one message. See Agent chat and goals.

5. Optional offline continuation

For automatic sends to an offline ChatGPT conversation:

codexify browser install
codexify browser login
codexify browser status

Set the exact plugin/connector name in global Browser settings, pair the intended ChatGPT conversation URL, and complete its verification call. Automation is configured on by default, but requires the installed, signed-in companion and verified pairing to work. ChatGPT Project placement is optional.

While the agent is online, messages use the normal chat tools. When it becomes offline, pending messages or an active goal can use the shared browser queue. See Browser automation for pairing, retries, and their limits.

6. Check the installation

codexify service status
codexify doctor
codexify browser status

The last command is relevant only if using the companion. Troubleshooting separates service, tunnel, startup, sign-in, pairing, connector-schema, and conversation errors.


Reviewed against v2.3.9 on 22 October 2026. Source: src/quickstart.rs · src/owner_chat.rs.

Clone this wiki locally