Skip to content

Commit 9adf2d0

Browse files
baozhoutaoclaude
andcommitted
docs: remove stray -- from fresh-backend dev commands (#2801)
pnpm passes the -- separator through to the script verbatim, so `pnpm dev -- --fresh -p <port>` reaches the CLI as positional args and exits with "Unexpected arguments" before binding the port. Drop the -- from all documented commands and fix the AGENTS.md note that claimed flags after -- are forwarded. Fixes #2801 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
1 parent 021ba4c commit 9adf2d0

4 files changed

Lines changed: 7 additions & 7 deletions

File tree

AGENTS.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,14 @@ pnpm docs:dev # docs site
2828
| Scenario | Command | Notes |
2929
|:---|:---|:---|
3030
| **Frontend debug** (UI in `../objectui` calls backend) | `PORT=3000 pnpm dev` | `pnpm dev` = the **showcase** kitchen-sink app (default; best for exercising the platform). Port **must** be 3000 (UI hard-wired); persistent state; leave running. For the minimal CRM app instead: `PORT=3000 pnpm dev:crm`. |
31-
| **Backend-only debug** | `pnpm dev -- --fresh -p <random>` | Random high port; ephemeral tempdir; **you must kill it** when done |
31+
| **Backend-only debug** | `pnpm dev --fresh -p <random>` | Random high port; ephemeral tempdir; **you must kill it** when done |
3232

3333
`--fresh`: ephemeral tempdir (auto-deleted on exit) + `--seed-admin` (POSTs sign-up, prints creds — default `admin@objectos.ai` / `admin123`, override via `--admin-email`/`--admin-password`). The seeded admin is auto-promoted to **platform admin** (the system seed identity `usr_system` is skipped), so Setup/Studio are reachable on first login.
3434

35-
Rules: never run two backends on port 3000; for backend tasks pick a random port and tear it down; **never kill a server you didn't start** (other agents/the user may be using it — see Multi-agent discipline §8); always use a `pnpm dev`/`dev:crm`/`dev:showcase` script (flags after `--` are forwarded), not raw `pnpm --filter`.
35+
Rules: never run two backends on port 3000; for backend tasks pick a random port and tear it down; **never kill a server you didn't start** (other agents/the user may be using it — see Multi-agent discipline §8); always use a `pnpm dev`/`dev:crm`/`dev:showcase` script (flags are forwarded as-is — no `--` separator, pnpm passes it through and the CLI rejects it), not raw `pnpm --filter`.
3636

3737
```bash
38-
pnpm dev:crm -- --fresh -p 38421 # start; debug via curl
38+
pnpm dev:crm --fresh -p 38421 # start; debug via curl
3939
kill $(lsof -ti tcp:38421) # tear down — tempdir auto-deletes
4040
```
4141

@@ -113,7 +113,7 @@ own worktree, operate defensively:
113113
8. **Testing needs a server? Start your own temporary one — never stop someone
114114
else's.** A running dev server you didn't start probably belongs to another
115115
agent or the user; killing it (or its port) breaks their in-flight work. Spin
116-
up your own instance on a random high port (`pnpm dev -- --fresh -p <random>`)
116+
up your own instance on a random high port (`pnpm dev --fresh -p <random>`)
117117
and **shut it down yourself when the task is done**
118118
(`kill $(lsof -ti tcp:<port>)`). Don't leave orphan servers behind.
119119

content/docs/deployment/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Use the repo scripts for framework development:
2424

2525
```bash
2626
OS_PORT=3000 pnpm dev
27-
pnpm dev:crm -- --fresh -p 38421
27+
pnpm dev:crm --fresh -p 38421
2828
pnpm docs:dev
2929
```
3030

content/docs/deployment/single-project-mode.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ From the framework repo:
6464
OS_PORT=3000 pnpm dev
6565
# showcase example, persistent state, console at /_console
6666

67-
pnpm dev:crm -- --fresh -p 38421
67+
pnpm dev:crm --fresh -p 38421
6868
# minimal CRM example with an ephemeral tempdir
6969
```
7070

docs/adr/0015-external-datasource-federation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -639,7 +639,7 @@ export default defineObject({
639639
os datasource validate warehouse
640640
# ✓ wh_order matches warehouse.mart.fact_orders (5/14 mapped, 9 unmapped — ok)
641641

642-
pnpm dev:crm -- --fresh -p 38421
642+
pnpm dev:crm --fresh -p 38421
643643
# [info] external-validation: 1 datasource, 1 object, 0 mismatches
644644
```
645645

0 commit comments

Comments
 (0)