Skip to content

Getting Started!

Migration

See the guides for migrating from other tools:

Supported Runtimes

  • Node.js: v18 or later
  • Bun: v1 or later

Installation

sh
$ npm install --save-dev @knuckles/cli
sh
$ yarn add --dev @knuckles/cli
sh
$ pnpm add --save-dev @knuckles/cli
sh
$ bun add --save-dev @knuckles/cli

Globally (optional)

It is recommend to install the command-line globally to use the ko binary anywhere. The local installation will still be used internally.

sh
$ npm install --save-dev --global @knuckles/cli
sh
$ yarn add --dev --global @knuckles/cli
sh
$ pnpm add --save-dev --global @knuckles/cli
sh
$ bun add --save-dev --global @knuckles/cli

Usage

WARNING

If you have not installed the command-line globally, you need to make sure to run the ko binary with your package manager.

sh
$ ko --help

What's next?

See setup guides for: