Skip to content

docs: align repo-run cli guidance with mirror-first root package surface #225

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ToadAid merged 1 commit into from
Mar 24, 2026
Merged

docs: align repo-run cli guidance with mirror-first root package surface #225

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/instructions/copilot.instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
## Stack & Commands

- **Package manager**: pnpm (`pnpm install`)
- **Dev**: `pnpm openclaw ...` or `pnpm dev`
- **Dev**: `pnpm mirror ...` or `pnpm dev`
- **Type-check**: `pnpm tsgo`
- **Lint/format**: `pnpm check`
- **Tests**: `pnpm test`
Expand Down
2 changes: 1 addition & 1 deletion docs/help/debugging.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ pnpm gateway:dev
OPENCLAW_PROFILE=dev openclaw tui
```

If you don’t have a global install yet, run the CLI via `pnpm openclaw ...`.
If you don’t have a global install yet, run the canonical repo CLI via `pnpm mirror ...`.

What this does:

Expand Down
2 changes: 1 addition & 1 deletion docs/install/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ For VPS/cloud hosts, avoid third-party "1-click" marketplace images when possibl
pnpm link --global
```

Alternatively, skip the link and run commands via `pnpm openclaw ...` from inside the repo.
Alternatively, skip the link and run canonical repo commands via `pnpm mirror ...` from inside the repo.
</Step>
<Step title="Run onboarding">
```bash
Expand Down
6 changes: 3 additions & 3 deletions docs/install/updating.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,9 +161,9 @@ openclaw health

Notes:

- `pnpm build` matters when you run the packaged `openclaw` binary ([`openclaw.mjs`](https://github.com/openclaw/openclaw/blob/main/openclaw.mjs)) or use Node to run `dist/`.
- If you run from a repo checkout without a global install, use `pnpm openclaw ...` for CLI commands.
- If you run directly from TypeScript (`pnpm openclaw ...`), a rebuild is usually unnecessary, but **config migrations still apply** → run doctor.
- `pnpm build` matters when you run the packaged CLI from a global install or use Node to run `dist/`.
- If you run from a repo checkout without a global install, use `pnpm mirror ...` for canonical CLI commands.
- If you run directly from the repo (`pnpm mirror ...`), a rebuild is usually unnecessary, but **config migrations still apply** → run doctor.
- Switching between global and git installs is easy: install the other flavor, then run `openclaw doctor` so the gateway service entrypoint is rewritten to the current install.

## Always Run: `openclaw doctor`
Expand Down
Loading