NimClaw 🦞

Ultra-efficient AI assistant in Nim. A high-performance implementation inspired by Nimclaw.

Features

• Independent implementations of all channels (Telegram, Discord, QQ, Feishu, DingTalk, WhatsApp, MaixCam).
• Powerful toolset: filesystem, shell, web, cron, spawn.
• <10MB RAM footprint.
• Zero heavy dependencies for channels.

Installation

Prerequisites

• Nim >= 2.0.0
• nimble

Build from Source

# Clone the repository
git clone https://github.com/bung87/nimclaw.git
cd nimclaw

# Install dependencies and build
nimble build -d:release

# Or compile directly
nim c -d:release src/nimclaw.nim

Quick Start

# 1. Initialize configuration
./nimclaw onboard

# 2. Edit config at ~/.nimclaw/config.json
#    Add your LLM API keys (OpenAI, Anthropic, OpenRouter, etc.)
#    Enable desired channels (Telegram, Discord, etc.)

# 3. Start the gateway (all enabled channels)
./nimclaw gateway

# 4. Or use interactive CLI mode
./nimclaw agent "Hello, what can you do?"

Commands

Command	Description
onboard	Create initial configuration
agent [message]	Run interactive agent or single query
gateway	Start message gateway with all channels

Configuration

Edit ~/.nimclaw/config.json:

{
  "agents": {
    "defaults": {
      "model": "gpt-4",
      "max_tokens": 8192
    }
  },
  "providers": {
    "openai": {
      "api_key": "sk-..."
    }
  },
  "channels": {
    "telegram": {
      "enabled": true,
      "token": "YOUR_BOT_TOKEN"
    }
  }
}

Skills

Skills extend nimclaw's capabilities by providing specialized knowledge and instructions.

Installing Skills

Skills are installed locally in your workspace:

# Create skill directory
mkdir -p ~/.nimclaw/workspace/skills/my_skill

# Add SKILL.md file
cat > ~/.nimclaw/workspace/skills/my_skill/SKILL.md << 'EOF'
---
name: my_skill
description: My custom skill
---

# My Skill

Your skill content here...
EOF

Skill Format

A skill is a directory containing a SKILL.md file:

~/.nimclaw/workspace/skills/
├── my_skill/
│   └── SKILL.md
└── another_skill/
    └── SKILL.md

The SKILL.md supports YAML frontmatter for metadata:

• name: Skill identifier
• description: Short description
• author: Author name
• tags: List of tags

Built-in Skills

nimclaw includes example skills in the skills/ directory:

# Copy example skill to your workspace
cp -r skills/example_skill ~/.nimclaw/workspace/skills/

Using Skills

Once installed, skills are automatically loaded into the agent's context. The LLM can:

1. Read skill files using the read_file tool to access skill documentation
2. Use skill knowledge to perform specialized tasks

Skills are located at ~/.nimclaw/workspace/skills/{skill-name}/ and typically contain:

• SKILL.md - Main skill documentation and instructions
• Additional files (templates, examples, etc.)

To use a specific skill, simply ask the agent to use it:

You: Use the pm-product-strategy skill to analyze my product idea
Agent: [reads the skill files and applies the methodology]

Installing Specific Skills from Monorepos

Some repos contain multiple skills in subdirectories (e.g., phuryn/pm-skills). Since GitHub API has rate limits, install specific skills like this:

# Install a specific skill from a subdirectory
./nimclaw skills --install phuryn/pm-skills/pm-product-strategy
./nimclaw skills --install phuryn/pm-skills/pm-data-analytics

Or clone the repo manually and install from local path:

# Clone the entire skills repo
git clone https://github.com/phuryn/pm-skills.git /tmp/pm-skills

# Install individual skills from local path
./nimclaw skills --from_path /tmp/pm-skills/pm-product-strategy
./nimclaw skills --from_path /tmp/pm-skills/pm-data-analytics