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 status

Display system health, configuration status, and component availability.

​
Usage

ironclaw status
This command provides a quick overview of IronClaw’s current state without making any changes to the system.

​
Output

The status command displays information about:

​
Version

IronClaw Status
===============

  Version:     ironclaw v0.13.1
Shows the currently installed IronClaw version.

​
Database

  Database:    connected (PostgreSQL)
Database connection status:
  • connected (PostgreSQL) - Successfully connected to PostgreSQL
  • libSQL (/path/to/ironclaw.db) - Using local libSQL database
  • libSQL (/path/to/ironclaw.db + Turso sync) - libSQL with Turso cloud sync enabled
  • not configured - No database configured (DATABASE_URL not set)
  • error (…) - Connection failed with error message

​
Session

  Session:     found (/Users/you/.ironclaw/session.json)
Authentication session status:
  • found - NEAR AI session exists (OAuth authenticated)
  • not found (run ironclaw onboard) - No session file (need to authenticate)

​
Secrets

  Secrets:     configured (env)
Secrets encryption configuration:
  • configured (env) - Master key set via SECRETS_MASTER_KEY environment variable
  • env not set (keychain may be configured) - Not in environment (may be in OS keychain)
The status command does not probe the OS keychain to avoid triggering password dialogs. If onboarding completed with keychain storage, the key is configured even if not shown here.

​
Embeddings

  Embeddings:  enabled (provider: openai, model: text-embedding-3-small)
Vector embeddings status:
  • enabled - Shows provider (openai, nearai, ollama) and model name
  • disabled - Embeddings not configured (memory search will use full-text only)

​
WASM Tools

  WASM Tools:  5 installed (/Users/you/.ironclaw/tools)
Count of installed WASM tools and installation directory:
  • N installed - Number of .wasm files found
  • directory not found - Tools directory doesn’t exist yet

​
Channels

  Channels:    cli, http:3000, 2 wasm
Active communication channels:
  • cli - Always available (REPL)
  • http:PORT - HTTP webhook server on specified port
  • N wasm - Number of WASM channels (Telegram, Slack, etc.)

​
Heartbeat

  Heartbeat:   enabled (interval: 3600s)
Background heartbeat system:
  • enabled - Periodic background tasks active with interval in seconds
  • disabled - Heartbeat system not active

​
MCP Servers

  MCP Servers: 2 enabled / 3 configured
Model Context Protocol server status:
  • N enabled / M configured - Number of active vs total configured servers
  • none configured - No MCP servers set up

​
Configuration Path

  Config:      /Users/you/.ironclaw/.env
Path to the bootstrap configuration file.

​
Example Output

$ ironclaw status
IronClaw Status
===============

  Version:     ironclaw v0.13.1
  Database:    connected (PostgreSQL)
  Session:     found (/Users/you/.ironclaw/session.json)
  Secrets:     configured (env)
  Embeddings:  enabled (provider: openai, model: text-embedding-3-small)
  WASM Tools:  5 installed (/Users/you/.ironclaw/tools)
  Channels:    cli, http:3000, 2 wasm
  Heartbeat:   enabled (interval: 3600s)
  MCP Servers: 2 enabled / 3 configured

  Config:      /Users/you/.ironclaw/.env

​
Use Cases

​
Quick Health Check

ironclaw status
Run before starting IronClaw to ensure everything is configured correctly.

​
Troubleshooting

# Check if database is accessible
ironclaw status | grep Database

# Verify session exists
ironclaw status | grep Session

# Count installed tools
ironclaw status | grep "WASM Tools"

​
CI/CD Integration

# Exit with error if not configured
ironclaw status | grep -q "not configured" && exit 1

# Verify minimum requirements
ironclaw status | grep -q "Database:.*connected" || exit 1
ironclaw status | grep -q "Session:.*found" || exit 1

ironclaw doctor

Run comprehensive diagnostics

ironclaw onboard

Configure IronClaw

ironclaw config

Manage configuration

Configuration

Configuration guide

​
Comparison: status vs doctor

CommandPurposeChecksOutput
statusQuick health overviewDatabase, session, tools countSummary table
doctorComprehensive diagnosticsAll dependencies, validation, networkDetailed pass/fail report
Use status for quick checks and doctor for thorough troubleshooting.

Build docs developers (and LLMs) love

Get started for freeTalk to us