Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/nearai/ironclaw/llms.txt

Use this file to discover all available pages before exploring further.

​
ironclaw registry

Browse and install extensions (tools and channels) from the IronClaw registry.

​
Usage

ironclaw registry <subcommand> [options]

​
Subcommands

​
ironclaw registry list

List available extensions in the registry. Usage: 
ironclaw registry list [options]
Options:
​
--kind, -k
string
Filter by extension kind: tool or channel
​
--tag, -t
string
Filter by tag (e.g., default, google, messaging)
​
--verbose, -v
boolean
Show detailed information for each extension
Examples: 
# List all extensions
ironclaw registry list

# List only tools
ironclaw registry list --kind tool

# List Google-related extensions
ironclaw registry list --tag google

# List with detailed information
ironclaw registry list --verbose
Output: 
Available extensions in registry:

Tools:
  gmail          - Gmail tool for reading and sending emails
  google-docs    - Google Docs integration
  google-sheets  - Google Sheets integration
  slack          - Slack bot integration
  web-search     - Web search tool

Channels:
  telegram       - Telegram channel (MTProto)
  slack          - Slack Events API channel
  discord        - Discord bot channel

Bundles:
  default        - Default set of recommended extensions
  google         - Complete Google Workspace suite

​
ironclaw registry info

Show detailed information about a specific extension or bundle. Usage: 
ironclaw registry info <name>
Arguments:
​
name
string
required
Extension or bundle name (e.g., slack, google, tools/gmail)
Examples: 
# Show info about Slack tool
ironclaw registry info slack

# Show info about Google bundle
ironclaw registry info google

# Show info about Gmail tool
ironclaw registry info tools/gmail
Output: 
Extension: slack
Kind: tool
Version: 0.1.0
Description: Slack bot integration for sending messages and managing channels
Tags: messaging, collaboration, default

Capabilities:
  - HTTP access to api.slack.com
  - Secrets: SLACK_BOT_TOKEN, SLACK_APP_TOKEN

Source: https://github.com/nearai/ironclaw/tree/main/tools-src/slack

​
ironclaw registry install

Install an extension or bundle from the registry. Usage: 
ironclaw registry install <name> [options]
Arguments:
​
name
string
required
Extension or bundle name to install
Options:
​
--force, -f
boolean
Force overwrite if the extension is already installed
​
--build
boolean
Build from source instead of downloading pre-built artifact
Examples: 
# Install Slack tool
ironclaw registry install slack

# Install Google bundle (all Google Workspace tools)
ironclaw registry install google

# Force reinstall
ironclaw registry install slack --force

# Build from source
ironclaw registry install slack --build
Output: 
Installing slack from registry...
Downloading artifact...
✓ Downloaded slack-v0.1.0-wasm32-wasi.wasm
✓ Installed to ~/.ironclaw/tools/slack.wasm
✓ Extracted capabilities to ~/.ironclaw/tools/slack.capabilities.json

Extension installed successfully!

Next steps:
  1. Configure credentials: ironclaw tool auth slack
  2. Restart IronClaw to load the tool

​
ironclaw registry install-defaults

Install the default bundle of recommended extensions. Usage: 
ironclaw registry install-defaults [options]
Options:
​
--force, -f
boolean
Force overwrite if extensions are already installed
​
--build
boolean
Build from source instead of downloading pre-built artifacts
Examples: 
# Install default extensions
ironclaw registry install-defaults

# Force reinstall all defaults
ironclaw registry install-defaults --force
Output: 
Installing default bundle (5 extensions)...

Installing tools:
  ✓ web-search
  ✓ gmail
  ✓ google-calendar

Installing channels:
  ✓ telegram
  ✓ slack

Successfully installed 5 extensions!

Next steps:
  1. Configure credentials for each extension
  2. Restart IronClaw to load the extensions

​
Extension Types

​
Tools

WASM-based tools that extend IronClaw’s capabilities:
  • API integrations - Gmail, Slack, Google Docs, etc.
  • Utilities - Web search, file processing, data transformation
  • Custom tools - Built by the community

​
Channels

Communication channels for interacting with IronClaw:
  • Telegram - MTProto-based Telegram integration
  • Slack - Slack Events API channel
  • Discord - Discord bot channel
  • WhatsApp - WhatsApp integration

​
Bundles

Pre-configured sets of related extensions:
  • default - Recommended tools and channels for getting started
  • google - Complete Google Workspace suite (Gmail, Docs, Sheets, Calendar, Drive, Slides)
  • messaging - All messaging channels (Telegram, Slack, Discord, WhatsApp)

​
Registry Structure

The registry is stored in the IronClaw repository at registry/: 
registry/
├── tools/
│   ├── gmail/
│   │   ├── manifest.json
│   │   └── releases/
│   ├── slack/
│   └── web-search/
├── channels/
│   ├── telegram/
│   ├── slack/
│   └── discord/
└── bundles/
    ├── default.json
    ├── google.json
    └── messaging.json

​
Troubleshooting

The extension may not exist in the registry. Run ironclaw registry list to see available extensions.
  • Check your internet connection
  • Verify the registry URL is accessible
  • Try building from source with --build flag
Ensure you have write permissions to ~/.ironclaw/tools/ directory:
chmod 755 ~/.ironclaw/tools
Restart IronClaw to load newly installed extensions:
# Stop IronClaw (Ctrl+C or service stop)
ironclaw service stop

# Start again
ironclaw

​
See Also

Tool Management

Manage WASM tools

WASM Tools

Learn about WASM tool system

Building Tools

Build custom tools

Extensions

Tools & Extensions overview

Build docs developers (and LLMs) love

Get started for freeTalk to us