View Markdown ↗

Set up your coding agent

Ask a question about your code. Your agent writes the brief, runs Codeclip, and shares the finished clip.

“Make a clip explaining how this queue handles retries.”

Works with local Codex, Claude Code, and Cursor agents with terminal access. No MCP server or model API keys are required.

Instructions for coding agents

Complete both CLI installation and skill setup before reporting that Codeclip is ready. Install the skill for the agent you are operating in, read its SKILL.md, and follow its workflow. Write the brief using the user’s question and relevant conversation context, then operate Codeclip for them.

Respect your environment’s permissions. If installation is blocked, explain the remaining step. Do not generate a clip solely to test installation: new runs consume credits.

1. Install Codeclip

brew install sidhantchadda/codeclip/codeclip

Already installed? Run brew upgrade codeclip. Verify with codeclip --version; agent setup requires 0.1.9 or later.

Current binaries support macOS Apple silicon and Linux ARM64. See other installation options if you don’t use Homebrew.

2. Install the skill

Run the command for your current agent:

Agent Command
Codex codeclip agents --agent codex
Claude Code codeclip agents --agent claude
Cursor codeclip agents --agent cursor

Setup installs the clip and video skills in the user’s skill directory and prints their locations. Read the installed SKILL.md. Installation is offline and preserves unrelated or edited skills. Resolve name conflicts without overwriting the user’s work.

Reload skills or start a new agent session if they aren’t discovered. Local installation does not configure hosted agents.

3. Connect your account

Check the current session:

codeclip account --json

If sign-in is required, run:

codeclip login

Let the user finish authentication in their browser, then check the account again. Each user starts with two free clips. If no credits remain, explain the limitation before generation.

4. Ask for a clip

Use a natural-language request, or invoke the skill:

Agent Invocation
Codex $clip or $video
Claude Code / Cursor /clip or /video

The agent should resolve references like “this flow” from the conversation and repository, write a focused Markdown brief, and invoke Codeclip itself. Ask a clarifying question only when the topic or repository remains unclear.

codeclip generate /absolute/path/to/repository \
  --brief /absolute/path/to/brief.md \
  --json --wait

Share the tracking link as soon as it arrives. Keep the local process alive until the report is submitted, then follow generation through completion.

Keep going

Writing a useful brief explains what context to include. Tracking and resuming runs covers interruptions. For automation, see the JSON event reference.