Skip to content

Add commands to run CLI in CONTRIBUTING.md #685

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add commands to run CLI in CONTRIBUTING.md #685

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
982656b
(docs) Add the commands for starting CLI in CONTRIBUTING.md
AnshulYADAV007 Sep 24, 2025
48f77f6
chore(docs): add changeset
AnshulYADAV007 Sep 24, 2025
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: 2 additions & 0 deletions .changeset/funny-months-float.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
---
---
8 changes: 8 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,14 @@ pnpm install
pnpm dev # runs the website and playgrounds
```

To start the CLI:

```bash
pnpm build
cd apps/cli
pnpm dev -b
```
Comment on lines +92 to +98
Copy link
Contributor

@coderabbitai coderabbitai bot Sep 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Fix CLI instructions to avoid ELIFECYCLE/node_modules missing errors.

Running build before install and switching dirs is causing the reported failures. Recommend installing at the workspace root and starting CLI directly via -C.

Apply this diff:

-```bash
-pnpm build
-cd apps/cli
-pnpm dev -b
-```
+```bash
+pnpm -w install
+pnpm -C apps/cli dev
+```

Notes:

  • Drop “-b” unless there’s a specific need; it can forward Turbo flags unexpectedly.
  • Alternative (from repo root): pnpm dev --filter ./apps/cli
🤖 Prompt for AI Agents 
In CONTRIBUTING.md around lines 92 to 98, the CLI startup steps run pnpm build
then cd into apps/cli and run pnpm dev -b which causes ELIFECYCLE/node_modules
missing errors; update the instructions to first install dependencies at the
workspace root with pnpm -w install and then start the CLI from the repo root
with pnpm -C apps/cli dev (drop the -b flag), and optionally note the
alternative pnpm dev --filter ./apps/cli for running from the root.


Useful commands:

* `pnpm dev` — start all dev servers
Expand Down