Skip to content

docs(agents): update root commands from npm to pnpm - #4

Merged
bfoxhound merged 1 commit into
mainfrom
docs/agents-pnpm-commands
Jul 28, 2026
Merged

docs(agents): update root commands from npm to pnpm#4
bfoxhound merged 1 commit into
mainfrom
docs/agents-pnpm-commands

Conversation

@bfoxhound

Copy link
Copy Markdown
Owner

Summary

PR #2 converted CI to pnpm, but AGENTS.md still documented the root scripts as npm run lint / frontend:typecheck / sqlc / api. This updates the docs to match reality:

  • Commands section and API-contract section now use pnpm run ... (matching packageManager: pnpm@9.15.0 and CI's pnpm install --frozen-lockfile / pnpm run api).
  • The stray npm run sqlc in the hard-rules list is updated too.
  • Added one sentence documenting the split: the root is a pnpm workspace, while frontend/ is deliberately not in pnpm-workspace.yaml and remains npm-managed (npm ci in its workflows) — so the frontend-specific npm run typecheck / npm run build commands are intentionally unchanged.
  • The api:ts comment no longer claims npx openapi-typescript@7.4.4; the script now runs the local openapi-typescript dependency.

Intentional omissions

npx @redwoodjs/agent-ci run --all is a one-off npx invocation, not a root script, so it is left as-is.

Test

Docs-only; commands verified against package.json scripts and .github/workflows/*.yml.

🤖 Generated with Claude Code

PR #2 converted CI to pnpm (packageManager: pnpm@9.15.0, pnpm install
--frozen-lockfile, pnpm run api in workflows) but AGENTS.md still
documented the root scripts as npm run lint/frontend:typecheck/sqlc/api.

Update the Commands and API-contract sections to pnpm and note the
split: the root is a pnpm workspace while frontend/ deliberately stays
npm-managed (npm ci in its workflows, not in pnpm-workspace.yaml), so
the frontend-specific npm commands are unchanged. Also drop the stale
npx openapi-typescript@7.4.4 wording — api:ts now runs the local
openapi-typescript dependency.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown

Test Coverage Report

No TypeScript source files changed in this PR.

@bfoxhound
bfoxhound merged commit 0e19f31 into main Jul 28, 2026
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant