Getting Started

Install Sidekick, choose Kay or Codex, and delegate your first coding task from Claude Code or Codex. If you're not sure where to begin, read Start Here first.

Need the reader map? See Audience, Glossary, and Compatibility. Codex users should start with Compatibility to distinguish the Codex host from the Codex sidekick.

What is Sidekick?

Sidekick is a Claude Code and Codex plugin that gives the active host two implementation sidekicks. Kay routes work through the Kay runtime and kay exec. Codex routes work through the local OpenAI Codex CLI and codex exec, pinned to gpt-5.4-mini with extra-high reasoning.

When you activate a sidekick, the host stops making direct implementation edits. The selected sidekick writes files and runs commands, while the host stays responsible for architecture, review, verification, and communication.

Why use a sidekick? Kay and Codex keep implementation work in a purpose-built child runtime while the host stays focused on task composition, quality review, verification, and communication.

Prerequisites

You need the following before installing Sidekick:

  • Claude Code or Codex host — required to run the Sidekick plugin surface.
  • Kay or Codex sidekick path — choose the child runtime that fits the task.
  • Runtime access — Kay needs a working kay exec path. Codex needs the real OpenAI Codex CLI with codex exec support; Sidekick rejects Kay compatibility aliases masquerading as Codex.
  • Node.js 18+ — required by Claude Code.
Readiness is per session. Sidekick loads the hook surface with the plugin, then checks Kay or Codex readiness when you start delegation for the current session.

Installation

Install Sidekick through the plugin surface for the host you use:

Claude Code
/plugin install alo-labs/sidekick
Codex
codex plugin marketplace add alo-labs/codex-plugins

Restart the host after installation so the hook surface loads before you start a Kay or Codex session. Sidekick does not install SessionStart hooks; runtime readiness is checked when delegation starts for the current session.

Codex users should install the Codex-facing Sidekick package through the Codex plugin surface. That path exposes the shared skill bodies and runtime guidance without duplicating writable state from Claude Code.

Health Check

After installing, verify the runtime for the sidekick path you plan to use.

Codex health check

In the host, run:

in any host session
/sidekick:codex-delegate # the host activates Codex sidekick mode and checks the local OpenAI Codex CLI

On activation, Codex mode verifies that the real OpenAI Codex CLI is available, is not Kay's compatibility alias, and supports codex exec --ask-for-approval. Sidekick then creates the current-session marker, writes active-sidekick=codex, and routes implementation through codex exec.

A successful health check means the child command can run with Sidekick's managed defaults:

✓ OpenAI Codex CLI found ✓ codex exec supports --ask-for-approval ✓ model pinned to gpt-5.4-mini ✓ reasoning effort set to xhigh ✓ Codex sidekick mode active
Health check failing? See Troubleshooting → Health check failures for common causes and fixes.

Kay health check

For the Kay path, verify that the Kay runtime is reachable. Claude Code and Codex both start Kay mode through /sidekick:kay-delegate; active Kay mode then routes implementation through the native kay exec child runtime while Sidekick maintains .kay/conversations.idx.

Kay runtime
kay --version # legacy aliases may also exist kay exec --help kay login --provider opencode-go --with-api-key # if provider login is missing

Your First Codex Task

Once the health check passes, the host is in Codex sidekick mode. Every implementation task you give the host is delegated to the local OpenAI Codex CLI through codex exec.

  1. 1

    Describe what to build

    Tell the host what you need in plain language. It will prepare a focused implementation prompt with the relevant files, constraints, and success criteria.

  2. 2

    Host submits to Codex

    The host delegates through codex exec. Sidekick injects -m gpt-5.4-mini, -c model_reasoning_effort=xhigh, --sandbox workspace-write, and --ask-for-approval never automatically.

  3. 3

    Host monitors output

    The host watches bounded, redacted Codex output and checks whether the child process completed the requested work.

  4. 4

    Review and confirm

    The host verifies the diff, integration points, and relevant commands before reporting success. If verification fails, it relaunches Codex with focused correction context.

First task recommendation: Start with a small, well-scoped task like "add a --verbose flag to the CLI" or "write unit tests for the auth module." This lets you observe the delegation flow without risking complex failures.

Your First Kay Task

Start Kay mode through /sidekick:kay-delegate. Use /sidekick:kay-delegate xiaomi for Xiaomi routing, /sidekick:kay-delegate ocg to force OpenCode Go routing, or SIDEKICK_KAY_PROVIDER as an environment override.

Kay activation surface
/sidekick:kay-delegate /sidekick:kay-delegate xiaomi /sidekick:kay-delegate ocg

Once Kay mode is active, the hook keeps kay exec as the child runtime command, surfaces bounded redacted output, and preserves project-local .kay/conversations.idx lookup metadata.

AGENTS.md Bootstrap

Sidekick relies on repository instructions such as AGENTS.md. The host and sidekick both treat those instructions as project context when preparing implementation and verification work.

You can edit AGENTS.md at any time to add project-specific rules, supported sidekicks, testing expectations, release discipline, and verification requirements.

AGENTS.md tiers

Current Sidekick keeps canonical workflows under skills/ and renders host bundles under agents/claude/ and agents/codex/. Do not hand-edit generated copies unless the canonical skill and renderer contract change with them.

What's Next

Now that Kay or Codex is configured, explore the rest of the documentation: