Prerequisites
Before you begin, make sure the following are available on your machine:- Node.js 18 or higher — download from nodejs.org or install via a version manager such as
nvmorfnm. - pnpm or bun — install pnpm with
npm install -g pnpmor bun from bun.sh.
Installation Steps
1
Clone the repository
Clone the Toolkit source and move into the project directory:
2
Install dependencies
Install all project dependencies using your preferred package manager:
3
Build the project
Compile the TypeScript source and bundle the CLI binary:The build output lands in the
dist/ directory and registers the toolkit binary so it is ready to run.4
Verify the installation
Confirm that the build succeeded and the CLI is accessible:You should see the following output:If you see the version number, Toolkit is installed and ready to use.
Using the CLI
There are two ways to invoke Toolkit commands depending on your setup:- Directly as
toolkit— if you performed a global install or thedist/binary is on yourPATH, run commands astoolkit <command>. This is the recommended approach for day-to-day use. - Via
pnpm toolkit— if you are working from inside the cloned repository and have not added the binary to yourPATH, prefix every command withpnpm, for examplepnpm toolkit ports list.
All examples in these docs use
toolkit directly. If running from the repo without a global install, substitute pnpm toolkit for toolkit in every command shown.