Skip to main content

📦 Installation

Woosh is a CLI tool used for automated token operations on Solana. Below are instructions tailored to each major operating system. Woosh is built as an npm package, so the first requirement is Node.js. It comes bundled with npm (Node Package Manager), which is required to install Woosh.

✅ Step-by-Step Guide to Install & Use Woosh​

🪟 Windows​

1. Install Node.js​

  • Go to https://nodejs.org

  • Download the LTS version for Windows.

  • Run the installer (.msi file) and follow the default prompts.

  • After installation, open Command Prompt (search for cmd) and run:

    node -v
    npm -v

    You should see version numbers for both.

2. Install Visual Studio Code​

3. Create a Woosh Project​

  • Open Command Prompt or PowerShell.

  • Navigate to your desired folder using:

    cd path\to\your\project

    Example:

    cd C:\Users\YourName\Documents

  • Create a new Woosh config:

    npx create-woosh my-woosh-project
    cd my-woosh-project

4. Install Woosh CLI Globally​

npm install -g woosh-cli

🧠 Note: On Windows, even after installing globally, the CLI might not be available directly in terminal due to path issues. If this happens, just run Woosh using:

npx woosh

5. Open Project in VS Code​

code .

If code command doesn't work, open VS Code manually → File > Open Folder → choose your project folder.

🐧 Ubuntu / Linux​

1. Install Node.js & npm​

Open your terminal and run:

sudo apt update
sudo apt install nodejs npm -y

Check versions:

node -v
npm -v

2. Install Visual Studio Code​

3. Create a Woosh Project​

Open terminal:

mkdir my-woosh-project
cd my-woosh-project
npx create-woosh .

4. Install Woosh CLI Globally​

sudo npm install -g woosh-cli

If global install doesn't link correctly, use:

npx woosh

5. Open in Visual Studio Code​

code .

🍎 macOS​

1. Install Node.js​

  • Go to https://nodejs.org

  • Download and install the macOS Installer (.pkg) for LTS version.

  • After installation, open Terminal (press Cmd + Space, type “Terminal”) and run:

    node -v
    npm -v

2. Install Visual Studio Code​

  • Download from https://code.visualstudio.com

  • Drag the app into your Applications folder.

  • To use the code command in terminal:

    • Open VS Code
    • Press Cmd + Shift + P → Type shell command → Select "Install 'code' command in PATH"

3. Create a Woosh Project​

In Terminal:

mkdir my-woosh-project
cd my-woosh-project
npx create-woosh .

4. Install Woosh Globally​

sudo npm install -g woosh-cli

If the global CLI doesn’t work, use:

npx woosh

5. Open in Visual Studio Code​

code .

✅ Final Notes for All OS​

  • After setup, you should see a woosh.config.json file in your project directory. you need to configure the woosh.config.json file