Skip to main content

Installation

Install AIKit in minutes and start using structured workflows with your AI coding assistant.

🚀 NEW: AIKit now supports Google Antigravity - Google DeepMind's AI IDE!

Prerequisites

Before installing AIKit, ensure you have:

  • Node.js version 18.0 or above
  • npm package manager (comes with Node.js)
  • Google Antigravity, OpenCode, Cursor, or Claude Code CLI installed and configured

Check Node.js version:

node --version  # Should be v18.0.0 or higher
npm --version   # Should be 8.0.0 or higher

Installation Methods

Choose your preferred installation method:

Install from npm

The easiest way to install AIKit globally:

npm install -g @tdsoft-tech/aikit

This will:

  • Download and install the latest AIKit version
  • Make aikit command available globally
  • Set up all dependencies automatically

Why npm?

  • Always get the latest version
  • Easy updates with npm update -g @tdsoft-tech/aikit
  • No need to build manually
  • Works across all platforms

Step 1: Initialize Global Config

Create global AIKit configuration:

aikit init --global

This creates:

  • ~/.config/aikit/aikit.json - Global configuration
  • ~/.config/aikit/skills/ - Global skills (42 built-in skills)
  • ~/.config/aikit/commands/ - Global commands (42+ commands)
  • ~/.config/aikit/tools/ - Global tools
  • ~/.config/aikit/plugins/ - Global plugins

Step 2: 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 for AI agents
  • .aikit/skills/ - Project-specific skills (extends global)
  • .aikit/commands/ - Project-specific commands
  • .aikit/tools/ - Project-specific tools
  • .aikit/plugins/ - Project-specific plugins
  • .aikit/memory/ - Project memory
  • .aikit/sessions/ - Session tracking
  • .beads/ - Task tracking (automatically initialized)

Automatic Beads Setup

  • .beads/ directory is created automatically with full configuration
  • Ready to use with Antigravity, OpenCode, Cursor, and Claude Code - no manual setup required
  • Includes config.yaml, metadata.json, and git hooks
  • Track all development tasks with quality gates

Step 3: Install into Your AI Coding Assistant

Choose your AI coding assistant:

Install into Google Antigravity

aikit install antigravity

This makes all skills available in Google Antigravity's native format:

  • ✅ 42+ skills as SKILL.md files
  • ✅ Native folder structure (.agent/skills/)
  • ✅ Auto-discovery by Gemini agent
  • ✅ YAML frontmatter format
  • ✅ Progressive disclosure pattern

Prerequisites:

Skills are installed to: .agent/skills/<skill-name>/SKILL.md

Example skill structure:

.agent/skills/
├── aikit-plan/
│   └── SKILL.md
├── aikit-test/
│   └── SKILL.md
└── aikit-review/
    └── SKILL.md

Why Antigravity?

  • 🧠 Powered by Google's Gemini AI
  • 🚀 Next-generation AI coding experience
  • 🔄 Automatic skill discovery and activation
  • ⚡ Built by Google DeepMind

Configure Model Context Protocol (MCP) server for seamless OpenCode integration:

What is MCP?

MCP (Model Context Protocol) is a standard for connecting AI assistants with external tools. AIKit provides an MCP server that exposes all its capabilities to OpenCode.

OpenCode Configuration

Add AIKit MCP server to your OpenCode configuration:

OpenCode Desktop (Claude):

  1. Open Claude Desktop Settings
  2. Navigate to "Developer" → "MCP Servers"
  3. Add the following configuration:
{
  "mcpServers": {
    "aikit": {
      "command": "node",
      "args": [
        "/path/to/aikit/dist/mcp-server.js"
      ],
      "env": {
        "AIKIT_CONFIG": "/path/to/aikit.json"
      }
    }
  }
}

Configuration Options:

OptionDescriptionDefaultRequired
commandCommand to start MCP servernodeYes
args[0]Path to MCP server filedist/mcp-server.jsYes
env.AIKIT_CONFIGPath to AIKit config~/.config/aikit/aikit.jsonNo

Finding the MCP server path:

# Find AIKit installation directory
which aikit

# Common locations:
# npm global: /usr/local/lib/node_modules/@tdsoft-tech/aikit
# npm global (macOS): ~/.npm-global/lib/node_modules/@tdsoft-tech/aikit
# manual: /path/to/aikit

# Full path to MCP server:
/usr/local/lib/node_modules/@tdsoft-tech/aikit/dist/mcp-server.js

Verify MCP Connection

After configuring, restart Claude Desktop and verify MCP tools are available:

In Claude Desktop, you should see these tools:

  • find_skills(query)
  • use_skill(skillName)
  • list_agents()
  • delegate_to_agent(agentName, task)
  • list_commands(category)
  • run_command(commandName, args)
  • memory_read(key)
  • memory_update(key, content)
  • list_sessions(limit)
  • read_session(sessionId)
  • bead_create(title, description)
  • bead_update_status(id, status)
  • bead_complete(id)
  • bead_list([filter])

Tip: If tools don't appear, check Claude Desktop logs for errors and verify the path to mcp-server.js is correct.

Verify Installation

Check AIKit status:

aikit status

Expected output:

🚀 AIKit v0.1.30

✓ Configuration loaded
  Skills: 22
  Agents: 8
  Commands: 43
  Tools: 16
  Beads: Installed
  MCP Server: Available

List available components:

aikit skills list      # List all 22 skills
aikit agents list      # List all 8 agents
aikit commands list    # List all 42+ commands
aikit tools list       # List all tools
aikit plugins list     # List all plugins

Configuration

AIKit uses two-level configuration:

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

Applies to all projects. Contains default settings and shared resources.

Use for:

  • Default agent settings
  • Global skills (shared across projects)
  • Default tool configurations
  • Plugin settings

Project Config (.aikit/aikit.json)

Project-specific settings that override global config.

Use for:

  • Project-specific rules
  • Custom skills for this project
  • Project tool configurations
  • Team-specific settings

Update AIKit

If installed via npm:

npm update -g @tdsoft-tech/aikit

If installed via Git:

cd aikit
git pull origin main
npm install
npm run build
npm link

Uninstall

If installed via npm:

npm uninstall -g @tdsoft-tech/aikit

Then optionally clean up global config:

rm -rf ~/.config/aikit

If installed via Git:

npm unlink
rm -rf ~/.config/aikit

Troubleshooting

"aikit: command not found"

If the aikit command isn't found:

Via npm:

# Check npm global bin directory
npm config get prefix

# Add to PATH (example for macOS/Linux)
export PATH="$(npm config get prefix)/bin:$PATH"

# Or use full path
~/.npm-global/bin/aikit status

Via Git link:

# Relink the package
cd aikit
npm link

"Cannot find module"

If you get module errors:

# Reinstall dependencies
cd aikit
rm -rf node_modules
npm install
npm run build

Commands not showing in OpenCode

If AIKit commands don't appear in OpenCode:

# Reinstall into OpenCode
aikit install opencode

# Check installation directory
ls -la .opencode/command/

# Verify commands exist
aikit commands list

Commands not showing in Claude Code CLI

If AIKit commands don't appear in Claude Code CLI:

# Reinstall into Claude Code CLI
aikit install claude

# Check installation directory
ls -la .claude/commands/

# Verify commands exist
aikit commands list

Wrong commands installed for platform

If you accidentally installed for the wrong platform:

# For Google Antigravity
aikit install antigravity

# For OpenCode
aikit install opencode

# For Cursor
aikit install cursor

# For Claude Code CLI
aikit install claude

Skills not showing in Antigravity

If AIKit skills don't appear in Google Antigravity:

# Reinstall into Antigravity
aikit install antigravity

# Check installation directory
ls -la .agent/skills/

# Verify skills exist
aikit skills list

Note: Antigravity uses folder-based skills. Each skill is in its own folder with a SKILL.md file.

Commands not showing in Cursor

If AIKit commands don't appear in Cursor:

# Reinstall into Cursor
aikit install cursor

# Check installation directory
ls -la .cursor/commands/

# Verify commands exist
aikit commands list

Note: All AIKit commands in Cursor are prefixed with aikit- to avoid conflicts (e.g., /aikit-plan, /aikit-fix).

Permission errors (Linux/macOS)

If you get permission errors with global install:

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

# Then install again
npm install -g @tdsoft-tech/aikit

Next Steps