Skip to content

Commit 1d042f0

Browse files
committed
docs: update local dev workflow, remove pnpm link references
Replace misleading `pnpm link --global` instructions with `tsx cli.ts serve` (from source) and `node dist/cli.mjs serve` (from build). Add Playwright to checks section.
1 parent aa56adf commit 1d042f0

2 files changed

Lines changed: 30 additions & 8 deletions

File tree

AGENTS.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,28 @@ Pure TypeScript + DOM API — no framework. Transpiles to JS via tsdown for npm
2323
```bash
2424
git config core.hooksPath .hk-hooks # Run once after clone
2525
pnpm test # Run all tests
26+
pnpm run test:pw # Playwright e2e tests (chromium + webkit)
2627
pnpm run check # Biome lint + format check
2728
pnpm run check:fix # Auto-fix lint + format
2829
pnpm run build # Build dist/index.html (dev-time, uses tsx)
2930
pnpm run build:dist # Transpile for publishing (tsdown)
3031
```
3132

33+
## Local Development
34+
35+
From source (bundles overlay on the fly, no build step):
36+
37+
```bash
38+
tsx cli.ts serve # localhost:7681, default tmux session
39+
tsx cli.ts serve --port 8080 -- bash --norc # custom port, bash instead of tmux
40+
```
41+
42+
From a local build:
43+
44+
```bash
45+
pnpm run build:dist && node dist/cli.mjs serve
46+
```
47+
3248
## Conventional Commits
3349

3450
Commits must follow [Conventional Commits](https://www.conventionalcommits.org/) format, enforced by hk commit-msg hook.
@@ -93,7 +109,7 @@ Commits must follow [Conventional Commits](https://www.conventionalcommits.org/)
93109
- `npx semantic-release --dry-run` for local verification
94110
- Release triggers: `feat:` → minor, `fix:` → patch, `BREAKING CHANGE` → major
95111
- No release: `chore:`, `docs:`, `refactor:`, `test:`, `ci:`
96-
- `pnpm link --global` for local development (CLI available globally)
112+
- See **Local Development** above for running from source
97113

98114
## Conventions
99115

README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ npm install -g remobi
5353
remobi serve
5454
```
5555

56-
For local development, use `pnpm link --global` from the repo root instead of `npm install -g remobi`.
56+
For local development, see the [Development](#development) section below.
5757

5858
Open `http://localhost:7681` on the same machine to verify it works. For phone access, put a trusted proxy/tunnel in front of it, for example [Tailscale Serve](docs/guides/tailscale-serve.md).
5959

@@ -281,21 +281,27 @@ git config core.hooksPath .hk-hooks # enable commit hooks (conventional commit
281281

282282
### Running locally
283283

284+
From source (bundles overlay on the fly via esbuild — no build step needed):
285+
284286
```bash
285-
pnpm run build:dist # transpile TS → JS (tsdown) — must re-run after source changes
286-
node dist/cli.mjs serve # runs the locally-built version on http://localhost:7681
287+
tsx cli.ts serve # localhost:7681, default tmux session
287288
```
288289

289-
Or use `pnpm link --global` to make the `remobi` CLI available globally, then run `remobi serve`.
290+
Or build first, then run from dist/:
291+
292+
```bash
293+
pnpm run build:dist # transpile TS → JS + bundle overlay
294+
node dist/cli.mjs serve # run locally-built version on localhost:7681
295+
```
290296

291-
There is no watch mode — re-run `pnpm run build:dist` after each code change.
297+
No watch mode — re-run the build or use `tsx` for automatic source bundling.
292298

293299
### Checks
294300

295301
```bash
296-
pnpm test # vitest
302+
pnpm test # vitest (unit + integration)
303+
pnpm run test:pw # playwright e2e (needs: pnpm exec playwright install chromium webkit --with-deps)
297304
pnpm run check # biome lint + format
298-
pnpm run build # build dist/index.html (dev-time, uses tsx + esbuild)
299305
```
300306

301307
## FAQ

0 commit comments

Comments
 (0)