Skip to content
Starplex Docs

Get started · Step 3 of 3

Connect a repository

Connect your project folder, restart your agent when needed, then ask it to read your Starplex project.

Install the CLI, sign in, and open a terminal in the repository you want to use. You’ll need a Starplex project connected to that repository, and Claude Code, Codex or OpenCode installed.

  1. Write the relay entries

    Terminal window
    starplex setup-mcp

    Run this in the repository every time you connect a machine, including when relay entries are already committed. It writes entries for Claude Code, Codex and OpenCode, checks your sign-in, and reports what still needs attention.

    Read the result for each app. Follow any instructions to remove old user-level entries or resolve conflicting settings.

    Setup reports a conflict

    Read the named file and conflicting entry before changing it. Preserve unrelated settings. If you need help, share the conflict report with your agent.

  2. Restart your coding agent when told

    Use a fresh window or chat after changing the relay configuration. Keep the agent in this repository so it reads this folder's configuration.

    The agent can see its Starplex tools.

  3. Ask your agent to read the project

    Give it your project slug and ask it to read that project through its own Starplex tools. For example:

    Read my Starplex project using your Starplex tools and tell me its name
    and connected repositories. Ask me for the project slug if you need it.

    You're connected when the agent reads the right project through its own tools. A successful terminal command alone isn't this check.

    The agent can't see the tools

    Run setup again in the same folder and read the per-app report. Follow its restart instructions, then try the project read in a fresh chat.

Run starplex setup-mcp again after the project read. Its per-app report distinguishes a relay that has started from an agent that has read a project of this folder. Check the app you actually used.