Skip to main content

Installation

Install AIKit in minutes and start using structured workflows with OpenCode.

Prerequisites

  • Node.js version 18.0 or above
  • OpenCode installed and configured
  • npm or yarn package manager

Step 1: Install AIKit

Clone or download the AIKit repository:

git clone https://github.com/tdsoft-tech/aikit.git
cd aikit

Install dependencies:

npm install

Build the project:

npm run build

Link globally (optional):

npm link

Step 2: Initialize Global Config

Create global AIKit configuration:

aikit init --global

This creates:

  • ~/.config/aikit/aikit.json - Global configuration
  • ~/.config/aikit/skills/ - Global skills
  • ~/.config/aikit/commands/ - Global commands
  • ~/.config/aikit/tools/ - Global tools
  • ~/.config/aikit/plugins/ - Global plugins

Step 3: Initialize in Your Project

Navigate to your project and initialize:

cd your-project
aikit init

This creates:

  • .aikit/aikit.json - Project configuration
  • .aikit/AGENTS.md - Project-specific rules
  • .aikit/skills/ - Project-specific skills
  • .aikit/commands/ - Project-specific commands
  • .aikit/tools/ - Project-specific tools
  • .aikit/plugins/ - Project-specific plugins
  • .aikit/memory/ - Project memory

Initialize Beads task tracking:

bd init

This creates .beads/ directory for task tracking.

Step 5: Install into OpenCode

Install AIKit into OpenCode:

aikit install

This makes all skills, agents, and commands available in OpenCode.

Verify Installation

Check AIKit status:

aikit status

List available components:

aikit skills list
aikit agents list
aikit commands list
aikit tools list
aikit plugins list

Configuration

AIKit uses two-level configuration:

Global Config (~/.config/aikit/aikit.json)

Applies to all projects. Contains default settings and shared skills/commands/tools/plugins.

Project Config (.aikit/aikit.json)

Project-specific settings that override global config. Contains project rules, custom skills, etc.

Next Steps