Installation

Get DocKit installed and running in your project in under two minutes.

Prerequisites

Before installing DocKit, make sure your environment meets the following requirements:

• Node.js >= 18.0.0
• npm >= 9 or pnpm >= 8 or bun >= 1.0
• Git (for version control)

Package Manager

Install DocKit using your preferred package manager:

npm install dockit

pnpm add dockit

bun add dockit

Manual Setup

For projects that need full control, set up DocKit manually by adding it to an existing app:

// dockit.config.ts
import { defineConfig } from "dockit";

export default defineConfig({
  root: "./src",
  output: "./dist",
  plugins: [],
});

Verify Installation

Confirm everything is working by running the CLI version check:

npx dockit --version
# dockit v3.0.0