From c6a09870c01fb29e45d779493a42a753c994dac1 Mon Sep 17 00:00:00 2001 From: yt-ms <71541861+yt-ms@users.noreply.github.com> Date: Sat, 14 Dec 2024 15:33:59 +0000 Subject: [PATCH] docs: update CLI dev env setup instructions --- cli/DEVELOPER_GUIDE.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/cli/DEVELOPER_GUIDE.md b/cli/DEVELOPER_GUIDE.md index 99540160..9cf8f558 100644 --- a/cli/DEVELOPER_GUIDE.md +++ b/cli/DEVELOPER_GUIDE.md @@ -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.