Mimik AI Docs

Installation

Mimik AI supports macOS, Linux (Ubuntu/Debian, Fedora/RHEL, Arch), and Windows via WSL2. Choose your platform below to get started.

# Install via Homebrew
brew tap mimik-ai/tools
brew install mimik-ai

# Verify installation
mimik --version

# Download and install
curl -fsSL https://get.mimik-ai.com | bash

# Or use the .deb package
wget https://releases.mimik-ai.com/latest/mimik-ai_amd64.deb
sudo dpkg -i mimik-ai_amd64.deb

# Ensure WSL2 is installed, then inside your WSL terminal:
curl -fsSL https://get.mimik-ai.com | bash

Quick Start

Get up and running with Mimik AI in under 2 minutes.

mimik activate --key YOUR_LICENSE_KEY

mimik init --skills-dir ~/.mimik/skills

mimik install fullstack-developer
mimik install security-auditor
mimik install devops-engineer

# Skills are automatically loaded by your AI editor
# Supported: Claude Code, Cursor, Windsurf, VS Code + Copilot
mimik status

License Activation

After purchasing, you'll receive a license key via email within 30–60 minutes. The license key is a 64-character alphanumeric string.

# Activate your license
mimik activate --key mk_live_a1b2c3d4e5f6...

# Check license status
mimik license status

# Output:
# ✓ License: Pro (3 devices)
# ✓ Activated: 2026-03-08
# ✓ Devices: 1/3 used
# ✓ Updates: Lifetime

System Requirements

Skills Overview

Skills are the core building blocks of Mimik AI. Each skill is a self-contained package that teaches your AI assistant how to handle specific types of tasks — from writing React components to auditing Kubernetes clusters.

Skill Anatomy

Every skill contains:

• SKILL.md — The main instruction file with YAML frontmatter and detailed markdown instructions
• scripts/ — Optional helper scripts and utilities
• examples/ — Reference implementations and usage patterns
• resources/ — Additional templates, configs, or assets

Skill Categories

Knowledge Engine

The Knowledge Engine provides persistent, searchable memory across AI conversations. It automatically distills insights from your codebase, documentation, and past interactions into reusable knowledge items.

# Index your project for knowledge extraction
mimik knowledge index ./my-project

# Search your knowledge base
mimik knowledge search "authentication patterns"

# Export knowledge for sharing
mimik knowledge export --format json > team-knowledge.json

How Knowledge Items Work

• Knowledge is automatically extracted from conversations and code analysis
• Each item contains metadata, timestamps, and references to source files
• Items are version-controlled and can be shared across devices
• Semantic search enables natural-language queries against your knowledge base

Skill File Format

Skills follow a standardized YAML frontmatter + Markdown body format:

---
name: react-best-practices
description: React and Next.js performance optimization guidelines
version: 2.1.0
triggers:
  - react
  - nextjs
  - component optimization
  - performance
category: development
---

# React Best Practices

## Component Architecture
Always prefer functional components with hooks over class components.
Use `React.memo()` for expensive renders...

## Performance Patterns
### Code Splitting
Use `React.lazy()` with `Suspense` for route-based splitting...

### State Management
Prefer local state with `useState` and `useReducer` before reaching
for global state libraries...

Configuration

Mimik AI is configured via a mimik.config.yaml file in your home directory or project root.

# Mimik AI Configuration
version: 1

skills:
  directory: ~/.mimik/skills
  auto_update: true
  categories:
    - development
    - security
    - devops

knowledge:
  directory: ~/.mimik/knowledge
  max_items: 10000
  auto_index: true
  index_on_save: true

sync:
  enabled: true
  mode: p2p           # peer-to-peer, no cloud
  encryption: aes-256
  auto_discover: true

editor:
  integration: auto    # auto-detect editor
  hot_reload: true     # reload skills on file change

Custom Skills

Create your own skills tailored to your team's workflows, coding standards, or domain expertise.

# Scaffold a new skill
mimik skill create my-company-standards

# This creates:
# ~/.mimik/skills/my-company-standards/
# ├── SKILL.md          # Main instruction file
# ├── scripts/          # Helper scripts
# ├── examples/         # Reference code
# └── resources/        # Templates & assets

# Test your skill locally
mimik skill test my-company-standards

# Share with your team (Enterprise plan)
mimik skill publish my-company-standards --scope team

Multi-Device Sync

Sync your skills and knowledge across devices using encrypted peer-to-peer connections. No data ever leaves your network.

# On your primary device: generate a pairing code
mimik sync init
# Output: Pairing code: MKMK-7F3A-9B2D

# On your secondary device: pair using the code
mimik sync pair MKMK-7F3A-9B2D

# Check sync status
mimik sync status
# ✓ Connected devices: MacBook Pro, Linux Desktop
# ✓ Last sync: 2 minutes ago
# ✓ Skills synced: 127/127
# ✓ Knowledge items: 3,421/3,421

CLI Reference

Troubleshooting

mimik doctor
# This runs diagnostics and fixes common issues

mimik activate --key YOUR_KEY --verbose
# This shows detailed activation logs

# Check if the sync port is open
mimik sync diagnose

# Manually specify port if needed
mimik sync init --port 9876