← Home

Setup console

See how Shipper is set up for this repo. Plan and build in your coding agent.

  1. 1

    Install

    Run the install script once on your machine:

    curl -fsSL https://raw.githubusercontent.com/shipper-is/shipper/main/install.sh | sh
  2. 2

    Open the console

    Run shipper in your repo. Your browser opens at http://shipper.localhost. The page shows how Shipper is set up for this repo and this user. It does not plan or build features. Those skills run in Claude Code, Cursor, or opencode. On first run, Shipper installs the bundled skills for each detected agent and creates the default artifact folders under .shipper/. It does not write a config file until you save one.

  3. 3

    Read the sections

    Overview summarizes the rest. Configuration shows the merged settings and the three files that produce them. Artifacts lists each directory (defaults under .shipper/, overridable in the repo config), open and done counts, and any files left behind in an old location. Skills, Search, MCP, and Agents show what is installed on this machine. A section with a problem is marked in the nav.

  4. 4

    Edit configuration

    The Configuration section has four tabs. Effective is read-only and names the layer behind each value. Repo (committed) edits .shipper/config.json, including artifact paths — commit that file so the team shares it. Local edits .shipper/config.local.json, which Shipper keeps out of git. Global edits ~/.config/shipper/config.json for every repo on this machine. Paths belong only in the repo file. Instructions from each layer are combined. Later layers win on other keys. Save writes the whole draft for that layer.

  5. 5

    Run an action

    Refresh skills reinstalls the bundled skills. Install and Uninstall register the MCP server for one agent or all of them. Sync index and Rebuild index update semantic search. Start server and Stop server control the local embedding process. One action runs at a time, and its progress stays on screen. Index buttons stay off when search is disabled for the repo. Hand-edits to a config file show up in the console on their own.