@lumpcode/cli 0.0.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Lumpcode
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,192 @@
+# Lumpcode CLI
+
+**Lumpcode is a tool to automate batched coding work** — large refactors, codemods, ticket queues, doc sweeps — by running your CLI coding agent (Claude Code, Aider, Codex, …) over many similar units of work in your repo, **one git branch per batch** for normal review. 
+
+> *Named after the **lumpfish**: a small cleaner fish that salmon farmers add to their pens to quietly pick parasites off the salmon. Lumpcode plays the same role in your codebase — steadily working through the long tail of repetitive coding chores (codemods, doc updates, missing tests) one batch at a time, not overflowing you with PRs, while you stay focused on you code.*
+
+A **lump** is one such campaign (e.g. "migrate every component to Vue"). It contains many **contexts** — Lumpcode's word for *units of work*: one component, one ticket, or a group of related files each — plus a prompt (or list of prompts) and an agent command. Each finished context is recorded with a fixed **marker commit** subject `LUMP: <lumpName> - <contextName>`, so repeated runs are **resumable** from remote git history after merges and reviews.
+
+**Use Lumpcode when** you have many similar edits (migrations, tests, docs), an ordered ticket queue, or a long-running refactor you want to tick forward on a schedule. However, Lumpcode is highly configurable and you can shape it easily to your custom needs.
+
+**New here?** Read [DOCS/concepts.md](DOCS/concepts.md) (two minutes), then [DOCS/get-started.md](DOCS/get-started.md).
+
+## Install
+
+Pick the option that fits your setup (see [lumpcode.com](https://lumpcode.com) for current installers):
+
+- **macOS (Homebrew):** `brew install lumpcode`
+- **Linux / macOS (curl):** follow the one-liner on the website
+- **Windows:** download the installer or binary from the website
+- **npm (Node 22+):** `npm install -g @lumpcode/cli@beta`
+
+During pre-launch, npm packages use the `beta` dist-tag. Omit `@beta` once `latest` is promoted.
+
+The npm package installs a `lumpcode` command that uses a **native binary for your OS when one is available** from the matching release; otherwise it runs the bundled CLI with Node. No extra steps are required.
+
+Operators can set `LUMPCODE_SKIP_BINARY=1` to skip the native download, `LUMPCODE_INSTALL_VERBOSE=1` for install diagnostics, or `LUMPCODE_INSTALL_REPO` to override the GitHub release source when configuring downloads.
+
+## Before you run anything
+
+You will need:
+
+- **A Lumpcode account** — sign up at [lumpcode.com](https://lumpcode.com); `lumpcode login` will prompt for credentials.
+- A project on your machine **with git push access to `origin`** for the repository you want to automate. The `baseBranch` you pick (e.g. `main`) must already exist on the remote — Lumpcode reads it via `origin/<baseBranch>`.
+- **A CLI coding agent on your `PATH`** — verify with e.g. `claude --version` or `aider --version`. Lumpcode invokes the agent through a **command module** registered by name (e.g. `claude`, `aider`) under `.lumpcode/commands/<name>.js` or `~/.lumpcode/commands/<name>.js`. See [DOCS/advanced-config.md](DOCS/advanced-config.md#custom-agent-commands).
+- **An understanding that `lumpcode run` calls your agent**, which usually means real LLM cost. Start with one context, review the resulting branch, then scale up.
+
+## 60-second tour
+
+From the root of a git repository:
+
+```bash
+lumpcode login
+lumpcode project-setup
+lumpcode lump-create myFirstLump
+```
+
+Edit `.lumpcode/lumps/myFirstLump/config.json` (see the [React-component example below](#configjson-example-one-branch-per-react-component)), then:
+
+```bash
+lumpcode run myFirstLump
+```
+
+This runs your agent on **one** context, commits a `LUMP: myFirstLump - …` marker, and pushes a `lump/myFirstLump/…` branch to `origin` for review.
+
+Step-by-step: [DOCS/get-started.md](DOCS/get-started.md).
+
+### Run continuously as a deamon
+
+Once a one-off `run` works end to end, have a background daemon tick every lump on a cron (default: every 5 minutes):
+
+```bash
+lumpcode start          # detached background daemon
+lumpcode daemon-status  # is it running?
+lumpcode stop           # SIGTERM + cleanup
+```
+
+Because the daemon keeps invoking your agent on every tick, **cap parallel work** with `maximumNumberOfConcurrentBranches` (per lump or in `project.json`) and set `"disabled": true` on a lump to take it out of the rotation without stopping the scheduler. 
+
+Sporadic `run` vs sustained `start`: [DOCS/concepts.md#when-to-use-run-vs-start-daemon](DOCS/concepts.md#when-to-use-run-vs-start-daemon).
+
+## How one `run` fits together
+
+```mermaid
+flowchart LR
+  start["lumpcode run myFirstLump"]
+  discover["Discover contexts"]
+  checkout["Work branch<br/>lump/myFirstLump/..."]
+  agent["Run agent"]
+  commit["Commit LUMP: myFirstLump - ..."]
+  push["Push origin"]
+  refresh["Update context status cache"]
+  start --> discover --> checkout --> agent --> commit --> push --> refresh
+```
+
+
+
+## `config.json` example: one branch per React component
+
+Suppose your repo has one folder per React component, each with the same three related files:
+
+```text
+src/components/
+├── Button/
+│   ├── Button.tsx
+│   ├── Button.types.ts
+│   └── Button.test.tsx
+├── Card/
+│   ├── Card.tsx
+│   ├── Card.types.ts
+│   └── Card.test.tsx
+└── Modal/
+    ├── Modal.tsx
+    ├── Modal.types.ts
+    └── Modal.test.tsx
+```
+
+`.lumpcode/lumps/myFirstLump/config.json`:
+
+```json
+{
+  "$schema": "https://lumpcode.com/schemas/lumpConfig.schema.json",
+  "baseBranch": "main",
+  "contextListJson": {
+    "COMPONENT": "src/components/{COMPONENT_NAME}/{COMPONENT_NAME}.tsx",
+    "TYPES":     "src/components/{COMPONENT_NAME}/{COMPONENT_NAME}.types.ts",
+    "TEST":      "src/components/{COMPONENT_NAME}/{COMPONENT_NAME}.test.tsx"
+  },
+  "prompt": {
+    "promptTemplate": "Tighten the prop types in @{COMPONENT} (declared in @{TYPES}) and add any missing assertions to @{TEST}.",
+    "command": "claude"
+  }
+}
+```
+
+Lumpcode scans the tree and finds every value `{COMPONENT_NAME}` can take such that **all three rows resolve to a real file**. With the tree above, that's three contexts — one per component:
+
+
+| Context name | `{COMPONENT}`                      | `{TYPES}`                               | `{TEST}`                                |
+| ------------ | ---------------------------------- | --------------------------------------- | --------------------------------------- |
+| `Button`     | `src/components/Button/Button.tsx` | `src/components/Button/Button.types.ts` | `src/components/Button/Button.test.tsx` |
+| `Card`       | `src/components/Card/Card.tsx`     | `src/components/Card/Card.types.ts`     | `src/components/Card/Card.test.tsx`     |
+| `Modal`      | `src/components/Modal/Modal.tsx`   | `src/components/Modal/Modal.types.ts`   | `src/components/Modal/Modal.test.tsx`   |
+
+
+Each context becomes one work branch (`lump/myFirstLump/Button`, …) and one marker commit (`LUMP: myFirstLump - Button`, …) on `origin`. A component missing any of the three files is silently skipped — that row would fail to match.
+
+- `contextListJson` — Each value is a **path template** with `{PLACEHOLDER}` captures; each key (here `COMPONENT`, `TYPES`, `TEST`) becomes a variable usable in the prompt as `{COMPONENT}`, `{TYPES}`, `{TEST}`. See [DOCS/lump-config.md#contextlistjson](DOCS/lump-config.md#contextlistjson).
+- `promptTemplate` — `{VAR}` substitutes the literal value; e.g you can safely use `@{VAR}` to have the same value with a leading `@` for agents that treat `@path` as file context. See [DOCS/lump-config.md#prompt-template-syntax](DOCS/lump-config.md#prompt-template-syntax).
+- `command` — Registered [command name](DOCS/lump-config.md#command-names) only (`"claude"`, `"aider"`, …), not shell flags ([DOCS/advanced-config.md#custom-agent-commands](DOCS/advanced-config.md#custom-agent-commands)).
+- `$schema` — Optional but recommended: most editors will then autocomplete and validate every field above.
+
+## TypeScript hints for `config.js` and command modules
+
+Optional npm package `[@lumpcode/cli-types](https://www.npmjs.com/package/@lumpcode/cli-types)` ships `defineConfig`, `defineCommand`, and other thin helpers plus the same types the CLI uses for lump config and `.lumpcode/commands/*.js`. See [DOCS/lump-config.md — Typed JavaScript config](DOCS/lump-config.md#typed-javascript-config-optional).
+
+## Where to next
+
+
+| Doc                                                | Contents                                                                           |
+| -------------------------------------------------- | ---------------------------------------------------------------------------------- |
+| [DOCS/concepts.md](DOCS/concepts.md)               | Project, lump, context, branch, context status; `run` vs `start`; workspace copies |
+| [DOCS/get-started.md](DOCS/get-started.md)         | Zero → first successful `lumpcode run`                                             |
+| [DOCS/commands.md](DOCS/commands.md)               | Every subcommand and flag                                                          |
+| [DOCS/project-config.md](DOCS/project-config.md)   | `.lumpcode/project.json`                                                           |
+| [DOCS/lump-config.md](DOCS/lump-config.md)         | `config.json` / `config.js` fields                                                 |
+| [DOCS/advanced-config.md](DOCS/advanced-config.md) | Hooks, dynamic `steps`, custom commands                                      |
+| [DOCS/examples.md](DOCS/examples.md)               | Ready-made lump shapes (smoke test, migration, tickets, codemods, docs, …)         |
+| [DOCS/types.md](DOCS/types.md)                     | Hook and JSON type shapes                                                          |
+
+## Running E2E
+
+Scenario tests invoke the CLI in a subprocess (not Vitest `handlerMaker`). They cover `run`, `start`, `lump-status`, and `clean` with a harness-generated Node mock agent command.
+
+From `packages/apps/cli`:
+
+```bash
+npm run test:e2e          # SEA: lazy build if binary missing, then scenarios
+npm run test:e2e:node     # Node: lazy build:bundle if missing, then same scenarios
+npm run test:e2e:ci       # SEA: always build:sea first (CI parity)
+npm run test:e2e:ci:node  # Node: always build:bundle first
+```
+
+All four use `scripts/run-e2e.mjs` (`--node` for the Node launcher, `--ci` to force a full build).
+
+On Windows (PowerShell), after building:
+
+```powershell
+npm run build:sea:windows
+$env:LUMPCODE_E2E_BINARY = ".\bin\lumpcode-windows-x64.exe"
+npm run test:e2e
+```
+
+`npm run test:e2e` auto-detects `bin/lumpcode-windows-x64.exe` on `win32` and runs `build:sea:windows` when the binary is missing. `npm run test:e2e:node` uses the npm launcher (`bin/lumpcode.js` → `node dist/index.js` when no `vendor/` binary is present). E2E subprocesses use an isolated temp profile (`USERPROFILE` and `HOME` on Windows) so daemon files and `project-copies` do not touch your real `%USERPROFILE%\.lumpcode`.
+
+Optional env overrides:
+
+- `LUMPCODE_E2E_BINARY` — path to an existing SEA binary (default runner)
+- `LUMPCODE_E2E_RUNNER=node` with `LUMPCODE_E2E_CLI_ENTRY` — Node launcher path (set automatically by `test:e2e:node`)
+
+Unit tests stay on `npm test` (E2E excluded via `vitest.config.ts`).
+
+

package/bin/lumpcode.js

@@ -0,0 +1,42 @@
+#!/usr/bin/env node
+
+const { spawn } = require('node:child_process');
+const fs = require('node:fs');
+const path = require('node:path');
+
+const pkgRoot = path.join(__dirname, '..');
+const vendorDir = path.join(pkgRoot, 'vendor');
+const markerPath = path.join(vendorDir, '.installed');
+const nativeBinary =
+    process.platform === 'win32'
+        ? path.join(vendorDir, 'lumpcode.exe')
+        : path.join(vendorDir, 'lumpcode');
+const distEntry = path.join(pkgRoot, 'dist', 'index.js');
+const args = process.argv.slice(2);
+
+function run(executable, executableArgs) {
+    const child = spawn(executable, executableArgs, {
+        stdio: 'inherit',
+        cwd: process.cwd(),
+        windowsHide: true,
+    });
+
+    child.on('error', (error) => {
+        console.error(error);
+        process.exit(1);
+    });
+
+    child.on('close', (code, signal) => {
+        if (signal) {
+            process.kill(process.pid, signal);
+            return;
+        }
+        process.exit(code ?? 1);
+    });
+}
+
+if (fs.existsSync(markerPath) && fs.existsSync(nativeBinary)) {
+    run(nativeBinary, args);
+} else {
+    run(process.execPath, [distEntry, ...args]);
+}