Skip to content
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

docs: update CLI dev env setup instructions #669

Merged
merged 1 commit into from
Dec 14, 2024
Merged

docs: update CLI dev env setup instructions #669

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 6 additions & 2 deletions cli/DEVELOPER_GUIDE.md
View file
Open in desktop
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
Loading