Skip to content

docs(contributing): add npm link step to developer setup #1483

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
dknos wants to merge 3 commits into
base: main
Choose a base branch
from
+13 −0
Open

docs(contributing): add npm link step to developer setup #1483

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f38642e
docs(contributing): add npm link step to developer setup
miyoungc Apr 5, 2026
785f2b4
docs(contributing): clarify working directory for npm link
miyoungc Apr 5, 2026
95d00e2
docs(contributing): clarify working directory before npm link
miyoungc Apr 6, 2026
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
13 changes: 13 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,19 @@ The CLI (`bin/`, `scripts/`) is type-checked separately:
npm run typecheck:cli # or: npx tsc -p tsconfig.cli.json
```

### Local Development Testing

After building, return to the repository root and link the CLI so the `nemoclaw` command is available locally.
If you followed the build step above, you are still inside `nemoclaw/` and must `cd ..` first:

```bash
cd .. # back to the repo root (from nemoclaw/ subdirectory)
npm link
nemoclaw --version # verify the linked version
```

To unlink when you are done: `npm unlink -g nemoclaw`

## Main Tasks

These are the primary `make` and `npm` targets for day-to-day development:
Expand Down