Skip to content

Commit b16999b

Browse files
committed
Update README to standardize command syntax with prompt indicators
1 parent de3bcc2 commit b16999b

File tree

1 file changed

+27
-27
lines changed

1 file changed

+27
-27
lines changed

README.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -41,23 +41,23 @@ The result: more time spent briefing AI than building, more time fixing AI's wor
4141
Hatchbox takes what context you already have, and works with you to build a shared mental model of the task at hand.
4242

4343
```bash
44-
npm -g install @hatchbox-ai/hatchbox-cli
44+
> npm -g install @hatchbox-ai/hatchbox-cli
4545

46-
gh auth login #hatchbox doesn't need your github access token, it uses the gh cli instead.
46+
> gh auth login #hatchbox doesn't need your github access token, it uses the gh cli instead.
4747

48-
hb start 25 # Pulls in issue 25 from GitHub, even if it's just an issue title. Fills in the blanks alongside you.
48+
> hb start 25 # Pulls in issue 25 from GitHub, even if it's just an issue title. Fills in the blanks alongside you.
4949

5050
# or
5151

52-
hb start "user auth broken" # Creates an issue, builds that same shared mental model from scratch.
52+
> hb start "user auth broken" # Creates an issue, builds that same shared mental model from scratch.
5353

5454
# or
5555

56-
hb start 34 # grabs context from this PR and its original issue, then iterates on it alongside you
56+
> hb start 34 # grabs context from this PR and its original issue, then iterates on it alongside you
5757

5858
# then
5959

60-
hb finish # it knows which hatchbox you're in, runs validation, and merges your code back to your primary branch.
60+
> hb finish # it knows which hatchbox you're in, runs validation, and merges your code back to your primary branch.
6161
# If you hit compilation/lint/test failures or merge conflicts along the way,
6262
# Claude will help resolve them automatically.
6363
```
@@ -84,7 +84,7 @@ Each Hatchbox follows the same workflow — structured, visible, repeatable.
8484
### Merge with Confidence
8585

8686
```bash
87-
hb finish
87+
> hb finish
8888
# ✅ Runs tests, types, lint - Claude helps fix any failures automatically
8989
# ✅ Generates commit message from the issue context
9090
# ✅ Handles merge conflicts with AI assistance
@@ -146,7 +146,7 @@ Hatchbox orchestrates specialized AI agents that analyze issues, evaluate comple
146146
### Creating Context
147147

148148
```bash
149-
hb start 25
149+
> hb start 25
150150
```
151151

152152
Hatchbox executes a multi-phase context-establishment workflow:
@@ -376,26 +376,26 @@ We (Claude and I) are actively working on expanding platform and integration sup
376376

377377
```bash
378378
# Install globally
379-
npm install -g @hatchbox-ai/hatchbox-cli
379+
> npm install -g @hatchbox-ai/hatchbox-cli
380380

381381
# Authenticate with GitHub
382-
gh auth login
383-
# do `gh auth login --scopes project` to automatically move issues to in progress
382+
> gh auth login
383+
# do `gh auth login --scopes project` to automatically move issues to in progress
384384

385385
# Initialize in your project
386-
cd your-project
386+
> cd your-project
387387

388388
# Start working
389-
hb start 25 # existing issue
390-
hb start "Enable log in/sign up with Google account" # new issue
389+
> hb start 25 # existing issue
390+
> hb start "Enable log in/sign up with Google account" # new issue
391391
```
392392

393393
## Pull Request Support
394394

395395
Hatchbox works identically with GitHub pull requests:
396396

397397
```bash
398-
hb start 125 # PR number instead of issue number
398+
> hb start 125 # PR number instead of issue number
399399
```
400400

401401
Automatically detects PR, fetches the branch, and creates hatchbox with PR context. Everything else works the same.
@@ -436,12 +436,12 @@ Hatchbox provides first-class support for Node.js web applications (next/express
436436
**How it integrates:**
437437

438438
```bash
439-
hb start 25
439+
> hb start 25
440440
# ✅ Runs `pnpm install` in worktree
441441
# ✅ Launches `pnpm dev` on port 3025 (3000 + issue number)
442442
# ✅ Sets up database branch with correct DATABASE_URL
443443

444-
hb finish
444+
> hb finish
445445
# ✅ Runs `pnpm test` (fails if tests fail)
446446
# ✅ Runs `pnpm build` (fails if build fails)
447447
# ✅ Runs `pnpm typecheck` if configured
@@ -458,14 +458,14 @@ Hatchbox was built using Hatchbox itself. CLI tools get the same isolation benef
458458
When you create a hatchbox for a CLI project, Hatchbox creates workspace-specific binaries so you can test each issue's version independently:
459459

460460
```bash
461-
hb start 52 # Working on CLI feature in issue 52
462-
cli-tool-52 --version # Test issue 52's version
461+
> hb start 52 # Working on CLI feature in issue 52
462+
> cli-tool-52 --version # Test issue 52's version
463463

464-
hb start 137 # Switch to different CLI issue
465-
cli-tool-137 --help # Test issue 137's version
464+
> hb start 137 # Switch to different CLI issue
465+
> cli-tool-137 --help # Test issue 137's version
466466

467467
# Original binary still works from main branch
468-
cli-tool --version # Unaffected by hatchbox CLIs
468+
> cli-tool --version # Unaffected by hatchbox CLIs
469469
```
470470

471471
**Binary naming**: `<original-name>-<issue/pr-number>`
@@ -492,13 +492,13 @@ A Git worktree is a separate working directory for the same repository. Instead
492492

493493
Traditional approach:
494494
```bash
495-
git checkout feature-a # Switch branch
495+
> git checkout feature-a # Switch branch
496496
# Edit files
497-
git stash # Save work
498-
git checkout feature-b # Switch branch again
497+
> git stash # Save work
498+
> git checkout feature-b # Switch branch again
499499
# Edit different files
500-
git stash pop # Restore work
501-
git checkout feature-a # Switch back
500+
> git stash pop # Restore work
501+
> git checkout feature-a # Switch back
502502
```
503503

504504
Git worktree approach:

0 commit comments

Comments
 (0)