> ## Documentation Index
> Fetch the complete documentation index at: https://toolkit.astralsolutions.tech/llms.txt
> Use this file to discover all available pages before exploring further.

# Install All-In-One Developer Toolkit on Any Platform

> Step-by-step instructions to install All-In-One Developer Toolkit on Windows, Linux, and macOS using Node.js 18 or higher and pnpm or bun.

All-In-One Developer Toolkit requires **Node.js 18 or higher** and either **pnpm** or **bun** as your package manager. The same installation steps work identically on Windows, Linux, and macOS — no platform-specific scripts or workarounds needed.

## Prerequisites

Before you begin, make sure the following are available on your machine:

* **Node.js 18 or higher** — download from [nodejs.org](https://nodejs.org) or install via a version manager such as `nvm` or `fnm`.
* **pnpm or bun** — install pnpm with `npm install -g pnpm` or bun from [bun.sh](https://bun.sh).

## Installation Steps

<Steps>
  <Step title="Clone the repository">
    Clone the Toolkit source and move into the project directory:

    ```bash theme={null}
    git clone https://github.com/programadorisgod/all-in-one-toolkit.git && cd all-in-one-toolkit
    ```
  </Step>

  <Step title="Install dependencies">
    Install all project dependencies using your preferred package manager:

    <CodeGroup>
      ```bash pnpm theme={null}
      pnpm install
      ```

      ```bash bun theme={null}
      bun install
      ```
    </CodeGroup>
  </Step>

  <Step title="Build the project">
    Compile the TypeScript source and bundle the CLI binary:

    <CodeGroup>
      ```bash pnpm theme={null}
      pnpm run build
      ```

      ```bash bun theme={null}
      bun run build
      ```
    </CodeGroup>

    The build output lands in the `dist/` directory and registers the `toolkit` binary so it is ready to run.
  </Step>

  <Step title="Verify the installation">
    Confirm that the build succeeded and the CLI is accessible:

    ```bash theme={null}
    toolkit --version
    ```

    You should see the following output:

    ```
    0.1.0
    ```

    If you see the version number, Toolkit is installed and ready to use.
  </Step>
</Steps>

## 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 the `dist/` binary is on your `PATH`, run commands as `toolkit <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 your `PATH`, prefix every command with `pnpm`, for example `pnpm toolkit ports list`.

<Note>
  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.
</Note>