Skip to content

Commit

Permalink
docs: update CLI dev env setup instructions (#669)
Browse files Browse the repository at this point in the history
  • Loading branch information
yt-ms authored Dec 14, 2024
1 parent 5abc944 commit ee0dbe9
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions cli/DEVELOPER_GUIDE.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,17 @@
# Developing the CALM CLI

## Prerequisites

We recommend using Node v20.18.1 (use `nvm` to manage node versions if needed). The `canvas` package we use does not seem to be compatible with later versions of node.

## Building & linking the CLI

Clone the project and run the following commands:
Clone the project and run the following commands from within this `cli` directory:

```shell
npm install
npm run build
npx link
npx link .
```

When you've made a change to the CLI and want to test it out, you can rerun the build and link steps.
Expand Down

0 comments on commit ee0dbe9

Please sign in to comment.