Installation

Prerequisites

Bun (for CLI) - Install Bun

Node.js v19+ (for SDK) - Install Node.js

Git - For version control

Install the CLI

npm
yarn
pnpm
Standalone Binary

npm install -g @flagkit-io/cli

yarn global add @flagkit-io/cli

pnpm add -g @flagkit-io/cli

# macOS/Linux
curl -fsSL https://flagkit.io/install | bash

# No dependencies required

Verify Installation

flagkit --version

You should see output like:

@flagkit-io/cli v0.1.0

Install the Core SDK

In your project directory:

npm
yarn
pnpm
bun

bash npm install @flagkit-io/core

bash yarn add @flagkit-io/core

bash pnpm add @flagkit-io/core

bash bun add @flagkit-io/core

Framework-Specific Packages

React

npm install @flagkit-io/react

Coming soon - currently in development

Vue

npm install @flagkit-io/vue

Coming soon - currently in development

Next.js

FlagKit works out-of-the-box with Next.js using the core SDK. No additional package required.

Troubleshooting

Command not found: flagkit

If you get a “command not found” error, ensure your global npm bin directory is in your PATH:

# Check npm global bin path
npm config get prefix

# Add to PATH (add to ~/.bashrc or ~/.zshrc)
export PATH="$PATH:$(npm config get prefix)/bin"

Permission errors during installation

If you encounter permission errors when installing globally:

# Option 1: Use npx (no global install needed)
npx @flagkit-io/cli init

# Option 2: Fix npm permissions
mkdir ~/.npm-global
npm config set prefix '~/.npm-global'
export PATH=~/.npm-global/bin:$PATH

Bun not found

FlagKit CLI requires Bun. Install it with:

curl -fsSL https://bun.sh/install | bash

Then restart your terminal or run:

source ~/.bashrc  # or ~/.zshrc

Next Steps

Quick Start Guide

Initialize your first FlagKit project

Getting Started

Core Concepts

Guides

Prerequisites

Install the CLI

Verify Installation

Install the Core SDK

Framework-Specific Packages

React

Vue

Next.js

Troubleshooting

Next Steps

Quick Start Guide

​Prerequisites

​Install the CLI

​Verify Installation

​Install the Core SDK

​Framework-Specific Packages

​React

​Vue

​Next.js

​Troubleshooting

​Next Steps

Quick Start Guide

Prerequisites

Install the CLI

Verify Installation

Install the Core SDK

Framework-Specific Packages

React

Vue

Next.js

Troubleshooting

Next Steps