@slahon/lazykit 1.2.5 → 1.2.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +33 -8
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -14,23 +14,49 @@ You describe what you want. Claude ships it.
|
|
|
14
14
|
npx @slahon/lazykit@latest init
|
|
15
15
|
```
|
|
16
16
|
|
|
17
|
-
Run this
|
|
17
|
+
Run this from your **project's root directory** — the same folder that contains your `.git` folder and has a GitHub remote configured. That's it. LazyKit handles everything else automatically.
|
|
18
18
|
|
|
19
19
|
## Requirements
|
|
20
20
|
|
|
21
21
|
- Node.js 18+
|
|
22
|
-
- A GitHub repository with a remote set up
|
|
22
|
+
- A GitHub repository with a remote set up (`git remote -v` should show a GitHub URL)
|
|
23
23
|
- A Claude Pro or Max subscription ([claude.ai](https://claude.ai))
|
|
24
24
|
- Claude Code installed locally (`npm install -g @anthropic-ai/claude-code`)
|
|
25
25
|
- GitHub CLI (`gh`) — required for full automation (`brew install gh` / [cli.github.com](https://cli.github.com))
|
|
26
26
|
|
|
27
|
+
> **All `npx @slahon/lazykit` commands must be run from your project's root directory** — the folder where your `.git` directory lives and your GitHub remote is configured.
|
|
28
|
+
|
|
27
29
|
## How it works
|
|
28
30
|
|
|
29
|
-
1.
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
31
|
+
### 1. Open an issue using the LazyKit Task template
|
|
32
|
+
|
|
33
|
+
Go to your repo on GitHub → **Issues → New issue**. You'll see a **"LazyKit Task"** option — click it to get a pre-filled form. Describe what you want Claude to build, then submit. The `lazykit` label is applied automatically by the template, so you don't need to do anything else.
|
|
34
|
+
|
|
35
|
+
### 2. GitHub Actions kicks in
|
|
36
|
+
|
|
37
|
+
The moment the issue is submitted, GitHub detects the `lazykit` label and triggers a workflow run. You can watch it live:
|
|
38
|
+
|
|
39
|
+
**Go to your repo → Actions tab → "Claude Issue-to-PR" workflow**
|
|
40
|
+
|
|
41
|
+
You'll see the run appear within seconds. Click into it to follow along in real time — Claude's output (what files it read, what changes it made, its reasoning) streams directly into the Actions log.
|
|
42
|
+
|
|
43
|
+
### 3. Claude reads, thinks, and writes
|
|
44
|
+
|
|
45
|
+
Inside the Actions runner, Claude:
|
|
46
|
+
- Reads your issue title and description
|
|
47
|
+
- Explores your codebase (guided by `CLAUDE.md` if you have one)
|
|
48
|
+
- Writes the code changes
|
|
49
|
+
- Commits them to a new branch
|
|
50
|
+
|
|
51
|
+
### 4. A pull request appears
|
|
52
|
+
|
|
53
|
+
When Claude is done, it opens a pull request against your main branch with a title, description, and a summary of what it did. You'll get a GitHub notification just like a PR from a teammate.
|
|
54
|
+
|
|
55
|
+
### 5. You review and merge
|
|
56
|
+
|
|
57
|
+
Look over the diff, request changes in comments if needed (Claude can re-run via `@claude`), then merge when you're happy.
|
|
58
|
+
|
|
59
|
+
---
|
|
34
60
|
|
|
35
61
|
You can also mention `@claude` in any issue comment to give follow-up instructions or re-trigger Claude mid-thread.
|
|
36
62
|
|
|
@@ -96,7 +122,6 @@ During `npx @slahon/lazykit@latest init` you will be asked:
|
|
|
96
122
|
|
|
97
123
|
| Option | Default | Description |
|
|
98
124
|
|--------|---------|-------------|
|
|
99
|
-
| Label name | `lazykit` | The GitHub label that triggers Claude |
|
|
100
125
|
| Auto-trigger | Yes | Trigger Claude on every new issue, or only when you apply the label |
|
|
101
126
|
| Generate CLAUDE.md | Yes | Create a project guide for Claude |
|
|
102
127
|
|