Skip to main content

Installation Guide

Complete guide to installing and configuring the clawhub CLI

Prerequisites

Before installing clawhub, ensure your system meets these requirements:

Required Software

  • Node.js 18.0.0 or higher
  • npm 9.0.0 or higher
    • Included with Node.js
    • Verify: npm --version
  • Claude Code CLI

Supported Platforms

PlatformSupportedNotes
macOS✅ YesmacOS 11 (Big Sur) or later
Linux✅ YesMost distributions supported
Windows✅ YesRequires WSL2 or Git Bash
Windows (native)⚠️ PartialSome features may not work

Installation

Method 1: Using npm (Recommended)

Install clawhub globally using npm:

npm install -g clawhub

The -g flag installs clawhub globally, making it available from any directory.

Method 2: Using Yarn

If you prefer yarn:

yarn global add clawhub

Method 3: Using pnpm

If you use pnpm:

pnpm add -g clawhub

Method 4: Install from Source

For development or testing the latest features:

# Clone the repository
git clone https://github.com/ZhenRobotics/clawhub.git
cd clawhub
# Install dependencies
npm install
# Link globally
npm link

Permission Issues?

If you encounter permission errors during installation, avoid using sudo. Instead, configure npm to use a different directory or use a Node version manager like nvm.

Configuration

After installation, clawhub needs to be configured to work with your Claude Code installation.

Automatic Configuration

Run the setup wizard:

clawhub setup

The wizard will:

  • Detect your Claude Code installation
  • Create necessary configuration files
  • Set up skill installation directories
  • Configure default preferences

Manual Configuration

If the automatic setup doesn't work, you can manually configure clawhub by creating a configuration file at ~/.clawhubrc:

{
"claudeCodePath": "/path/to/claude-code",
"skillsDirectory": "~/.clawhub/skills",
"registry": "https://www.zhenskill.com/api",
"autoUpdate": true
}

Configuration Options

OptionDescriptionDefault
claudeCodePathPath to Claude Code installationAuto-detected
skillsDirectoryWhere to install skills~/.clawhub/skills
registryZhenSkill API endpointhttps://www.zhenskill.com/api
autoUpdateAuto-update skillstrue

Verifying Installation

Check Version

Verify clawhub is installed correctly:

clawhub --version

Expected output:

clawhub version 1.0.0

Check Configuration

Verify your configuration:

clawhub config

This will display your current configuration settings.

Test Connection

Test connection to ZhenSkill registry:

clawhub search test

If you see search results, your installation is working correctly!

Installation Complete!

You're ready to start installing skills. Check out the Getting Started guide to install your first skill.

Updating clawhub

Check for Updates

clawhub update --self

Update via npm

npm update -g clawhub

Update via yarn

yarn global upgrade clawhub

Troubleshooting

Command Not Found

Problem: After installation, running clawhub returns "command not found".

Solution:

  1. Verify npm's global bin directory is in your PATH:
    npm config get prefix
  2. Add npm's bin directory to your PATH. Add this to your ~/.bashrc or ~/.zshrc:
    export PATH="$PATH:$(npm config get prefix)/bin"
  3. Restart your terminal

Permission Denied

Problem: "EACCES: permission denied" error during installation.

Solution:

  1. Use a Node version manager like nvm (recommended)
  2. Or change npm's default directory:
    mkdir ~/.npm-global
    npm config set prefix '~/.npm-global'
    export PATH=~/.npm-global/bin:$PATH

Claude Code Not Detected

Problem: clawhub can't find your Claude Code installation.

Solution:

  1. Verify Claude Code is installed and in your PATH
  2. Manually specify the path:
    clawhub config set claudeCodePath /path/to/claude-code

Network/Registry Issues

Problem: Can't connect to ZhenSkill registry.

Solution:

  1. Check your internet connection
  2. Verify you can access https://www.zhenskill.com
  3. Check if you're behind a corporate proxy and configure it:
    npm config set proxy http://proxy.company.com:8080

Still Having Issues?

If none of these solutions work: