Skip to content

docs: remove stray -- from fresh-backend dev commands#3140

Closed
baozhoutao wants to merge 1 commit into
mainfrom
claude/github-issue-2801-ee86eb
Closed

docs: remove stray -- from fresh-backend dev commands#3140
baozhoutao wants to merge 1 commit into
mainfrom
claude/github-issue-2801-ee86eb

Conversation

@baozhoutao

Copy link
Copy Markdown
Contributor

Summary

The documented fresh-backend command pnpm dev -- --fresh -p <port> fails: pnpm passes the -- separator through to the script verbatim, so the CLI receives objectstack dev --seed-admin -- --fresh -p <port>, treats everything after -- as positional arguments, and exits with Unexpected arguments: -p, <port> (exit code 2) before binding the port.

This PR removes the stray -- from every documented occurrence (6 commands across 4 files) and fixes the AGENTS.md note that claimed "flags after -- are forwarded" — that claim was the root cause of the wrong examples.

  • AGENTS.md: dev-server table, forwarding note, dev:crm example, multi-agent discipline §8
  • content/docs/deployment/index.mdx and single-project-mode.mdx: local runtime examples
  • docs/adr/0015-external-datasource-federation.md: example command in the validation walkthrough

Verification

  • With --: reproduced — CLI prints usage and exits 2 (matches the issue's 2/2 failures).
  • Without --: pnpm --filter @objectstack/example-showcase dev --fresh -p 38423 boots a fresh backend; /api/v1/health returns 200. Server torn down after verification.
  • grep -rn -- '-- --fresh' over AGENTS.md, content/, docs/ returns no matches.

Docs-only change; no CLI or runtime behavior touched.

Fixes #2801

🤖 Generated with Claude Code

@vercel

vercel Bot commented Jul 17, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
spec Ready Ready Preview, Comment Jul 17, 2026 2:15pm

Request Review

@github-actions github-actions Bot added documentation Improvements or additions to documentation size/s labels Jul 17, 2026
@os-zhuang os-zhuang closed this Jul 17, 2026
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size/s

Projects

None yet

Development

Successfully merging this pull request may close these issues.

文档(开发):文档中的全新后端启动命令多了一个 --

2 participants