Docs/Start

Overview

Lumpcode runs your coding agent through a campaign too big for one chat, one reviewable branch at a time. These pages are the operator manual.

On this page
  1. How to read these pages
  2. What Lumpcode does not do
  3. Packages

A lump is that campaign: a folder in your repo that names the work, the prompt, and the agent. Lumpcode walks the unfinished items, runs the agent, and pushes a lump/… branch. You open the pull request, adjust it if needed, and merge. The next run skips what already landed.

You just need git and a CLI agent. There is no account and no database. Finished work is a commit on your git remote.

First PRInstall the CLI and run one campaign by hand on your laptop. Leave a worker runningA second clone you never edit. Branches keep arriving while you merge. Write a lumpTwo required pieces: what to work on, and what to prompt. ExamplesMigrations, ticket queues, coverage sweeps, and retry-until-green.

How to read these pages

Start with core terms if the words are new, then how a run works. Authoring lives under Write a lump, Contexts, and Prompts. Config reference is for when you already know the shape and need a field. Types is the hook signatures. Commands is the CLI map. Troubleshooting is for the surprises git status can throw.

The tutorials at Get started are the shortest path to a real branch. These docs are what you open the week after, when the campaign is real.

What Lumpcode does not do

  • It does not merge. You do that.
  • It does not open pull requests by itself. A run stops at git push. Opening the PR is opt-in via @lumpcode/recipes.
  • It does not edit your day-to-day checkout when the machine is in shared mode. That is the default after project-setup.

Packages

Package Install when
@lumpcode/cli You want the lumpcode command. This is the product.
@lumpcode/cli-utils You author config.ts and want defineConfig plus typed helpers.
@lumpcode/recipes You want retry loops, folder backlogs, or openPrPostTeardown.

Add the last two to the project package.json (not only a global CLI) so a worker clone gets them from npm install.

Hook signatures: Types.

Edit this page