Installation

Get started with Hyperkit by installing the necessary dependencies and setting up your local environment. You can use our CLI to scaffold a new project or install the SDK manually.

Automatic Setup

The easiest way to start is using the create-hyperkit CLI tool. It will ask you a few questions and set up a pre-configured project with TypeScript, Tailwind, and the Hyperkit SDK.

# Install using npm
npm create hyperkit@latest

# Or using pnpm (recommended)
pnpm create hyperkit@latest

Manual Installation

If you prefer to add Hyperkit to an existing project, install the core SDK and the React hooks package.

npm install @hyperkit/core @hyperkit/react

Configuration

Create a hyperkit.config.ts file in the root of your project. This is where you define your API keys, networks, and agent behaviors.

import { defineConfig } from '@hyperkit/core';

export default defineConfig({
  apiKey: process.env.HYPERKIT_KEY,
  environment: 'development',
  networks: ['hyperion', 'metis'],
  agents: {
    autoAudit: true
  }
});

Next Steps

• Check out the Quickstart guide to build your first dApp.
• Read about Core Concepts to understand the architecture.
• Browse the Template Gallery for inspiration.