ZeptoClaw

https://zeptoclaw.com/docs/
Admin
An ultra-lightweight personal AI assistant built in Rust that packages streaming LLM responses,...
Tokens:18,366
Snippets:337
Trust Score:4.5
Update:4 months ago
Show doc for...
Tokens:
Raw
### Run the setup wizard

Source: https://zeptoclaw.com/docs/getting-started/quick-start

ZeptoClaw includes an interactive onboarding command that configures your provider keys and workspace. This creates `~/.zeptoclaw/config.json` with your settings.

```bash
zeptoclaw onboard
```

--------------------------------

### Batch examples

Source: https://zeptoclaw.com/docs/reference/cli

Examples of using the batch command.

```bash
# Process text file
zeptoclaw batch --input prompts.txt
```

```bash
# JSONL output
zeptoclaw batch --input prompts.txt --format jsonl --output results.jsonl
```

```bash
# With template and error handling
zeptoclaw batch --input prompts.jsonl --template researcher --stop-on-error
```

--------------------------------

### Gateway examples

Source: https://zeptoclaw.com/docs/reference/cli

Examples of using the gateway command.

```bash
# Start gateway
zeptoclaw gateway
```

```bash
# With container isolation
zeptoclaw gateway --containerized docker
```

--------------------------------

### Agent examples

Source: https://zeptoclaw.com/docs/reference/cli

Examples of using the agent command.

```bash
# Simple message
zeptoclaw agent -m "Hello"
```

```bash
# With streaming
zeptoclaw agent --stream -m "Explain async Rust"
```

```bash
# With template
zeptoclaw agent --template coder -m "Write a CSV parser"
```

--------------------------------

### Configuration Example

Source: https://zeptoclaw.com/docs/guides/plugins

How to enable and configure plugins in ZeptoClaw.

```json
{
  "plugins": {
    "enabled": true,
    "directories": ["~/.zeptoclaw/plugins", "/opt/zeptoclaw/plugins"]
  }
}
```

--------------------------------

### Onboard command

Source: https://zeptoclaw.com/docs/reference/cli

Run the interactive setup wizard.

```bash
zeptoclaw onboard [OPTIONS]
```

--------------------------------

### Full example

Source: https://zeptoclaw.com/docs/reference/configuration

A comprehensive example of the ZeptoClaw configuration file.

```json
{
  "providers": {
    "default": "anthropic",
    "anthropic": {
      "api_key": "sk-ant-...",
      "model": "claude-sonnet-4-5-20250929"
    },
    "openai": {
      "api_key": "sk-...",
      "model": "gpt-5.1"
    },
    "retry": {
      "enabled": true,
      "max_retries": 3,
      "base_delay_ms": 1000,
      "max_delay_ms": 30000
    },
    "fallback": {
      "enabled": true,
      "provider": "openai"
    }
  },
  "channels": {
    "telegram": {
      "enabled": true,
      "bot_token": "123456:ABC..."
    },
    "slack": {
      "enabled": false,
      "bot_token": "xoxb-..."
    },
    "discord": {
      "enabled": false,
      "bot_token": "MTIz...",
      "guild_id": "123456789"
    },
    "webhook": {
      "enabled": false,
      "bind": "0.0.0.0",
      "port": 8080,
      "auth_token": "my-secret"
    },
    "whatsapp_cloud": {
      "enabled": false,
      "phone_number_id": "...",
      "access_token": "..."
    },
    "lark": {
      "enabled": false,
      "app_id": "...",
      "app_secret": "..."
    }
  },
  "agents": {
    "defaults": {
      "agent_timeout_secs": 300,
      "message_queue_mode": "collect",
      "token_budget": 0,
      "streaming": false
    }
  },
  "approval": {
    "enabled": false,
    "require_approval": ["shell", "write_file"],
    "auto_approve": ["read_file", "memory"]
  },
  "plugins": {
    "enabled": true,
    "directories": ["~/.zeptoclaw/plugins"]
  },
  "telemetry": {
    "enabled": false,
    "format": "prometheus"
  },
  "cost": {
    "enabled": false,
    "warn_threshold_usd": 1.0
  },
  "hooks": {
    "before_tool": [],
    "after_tool": [],
    "on_error": []
  }
}

```

--------------------------------

### Setup a channel

Source: https://zeptoclaw.com/docs/reference/cli

Sets up a new notification channel.

```bash
zeptoclaw channel setup <NAME>

```

--------------------------------

### Install with script

Source: https://zeptoclaw.com/docs/getting-started/installation

Downloads the latest release binary for your platform and places it in your PATH.

```bash
curl -fsSL https://raw.githubusercontent.com/qhkm/zeptoclaw/main/install.sh | sh
```

--------------------------------

### Example: Build with OpenAI as default

Source: https://zeptoclaw.com/docs/reference/environment

This example shows how to set the default model to OpenAI's GPT-5.1 and then build the project.

```bash
export ZEPTOCLAW_DEFAULT_MODEL=gpt-5.1
cargo build --release
```

--------------------------------

### OpenClaw Configuration Example

Source: https://zeptoclaw.com/docs/guides/migration

Example of an OpenClaw configuration file in JSON5 format.

```json
{
  models: {
    providers: {
      anthropic: {
        apiKey: "sk-ant-...",
        baseUrl: "https://api.anthropic.com"
      },
      openai: {
        apiKey: "sk-...",
        baseUrl: "https://api.openai.com/v1"
      }
    }
  },
  agents: {
    defaults: {
      model: { primary: "claude-sonnet-4-5-20250929" },
      workspace: "~/projects",
      contextTokens: 100000
    }
  },
  channels: {
    telegram: { token: "123456:ABC..." },
    discord: { token: "MTIz..." }
  },
  session: { scope: "per-sender" }
}
```

--------------------------------

### Verify installation

Source: https://zeptoclaw.com/docs/getting-started/installation

Verifies the ZeptoClaw installation by checking the version and help output.

```bash
zeptoclaw --version
# zeptoclaw 0.5.0


zeptoclaw --help
# Shows available commands
```

--------------------------------

### Configure manually

Source: https://zeptoclaw.com/docs/getting-started/quick-start

Create the config directory and add your API key.

```bash
mkdir -p ~/.zeptoclaw

# Set your provider key
export ZEPTOCLAW_PROVIDERS_ANTHROPIC_API_KEY=sk-ant-...
# or
export ZEPTOCLAW_PROVIDERS_OPENAI_API_KEY=sk-...
```

--------------------------------

### Send your first message

Source: https://zeptoclaw.com/docs/getting-started/quick-start

Send a message to the agent.

```bash
zeptoclaw agent -m "Hello! What can you help me with?"
```

--------------------------------

### Gateway command

Source: https://zeptoclaw.com/docs/reference/cli

Start the multi-channel gateway.

```bash
zeptoclaw gateway [OPTIONS]
```

--------------------------------

### Streaming Example

Source: https://zeptoclaw.com/docs/concepts/agent-loop

Command-line example for running the ZeptoClaw agent with streaming enabled.

```bash
zeptoclaw agent --stream -m "Explain monads"
```

--------------------------------

### ZeptoClaw Configuration Example

Source: https://zeptoclaw.com/docs/guides/migration

Example of a ZeptoClaw configuration file in strict JSON format, showing the migrated structure.

```json
{
  "providers": {
    "default": "anthropic",
    "anthropic": {
      "api_key": "sk-ant-...",
      "api_base": "https://api.anthropic.com",
      "model": "claude-sonnet-4-5-20250929"
    },
    "openai": {
      "api_key": "sk-...",
      "api_base": "https://api.openai.com/v1",
      "model": "gpt-5.1"
    }
  },
  "agents": {
    "defaults": {
      "agent_timeout_secs": 300
    }
  },
  "compaction": {
    "enabled": true,
    "context_limit": 100000
  },
  "channels": {
    "telegram": {
      "enabled": true,
      "token": "123456:ABC..."
    },
    "discord": {
      "enabled": true,
      "token": "MTIz..."
    }
  }
}
```

--------------------------------

### Parameter Interpolation Example

Source: https://zeptoclaw.com/docs/guides/plugins

Demonstrates how parameters are substituted into a command template.

```json
{
  "command": "curl -X POST {{url}} -d {{data}}"
}
```

--------------------------------

### Build from source

Source: https://zeptoclaw.com/docs/getting-started/installation

Clones the ZeptoClaw repository, navigates into the directory, and builds the release binary using Cargo.

```bash
git clone https://github.com/qhkm/zeptoclaw.git
cd zeptoclaw

# Build release binary (~4MB)
cargo build --release
```

--------------------------------

### Install with Homebrew

Source: https://zeptoclaw.com/docs/getting-started/installation

Installs ZeptoClaw using the Homebrew package manager on macOS or Linux.

```bash
brew install qhkm/tap/zeptoclaw
```

--------------------------------

### Install with Cargo

Source: https://zeptoclaw.com/docs/getting-started/installation

Builds ZeptoClaw from source using Rust's package manager, Cargo.

```bash
cargo install zeptoclaw --git https://github.com/qhkm/zeptoclaw
```

--------------------------------

### Send your first message with streaming

Source: https://zeptoclaw.com/docs/getting-started/quick-start

Add `--stream` for real-time token-by-token output.

```bash
zeptoclaw agent --stream -m "List the files in my current directory"
```

--------------------------------

### Use a template

Source: https://zeptoclaw.com/docs/getting-started/quick-start

ZeptoClaw includes 4 built-in agent templates with specialized system prompts.

```bash
# Research mode
zeptoclaw agent --template researcher -m "What are the latest Rust async patterns?"


# Code assistant
zeptoclaw agent --template coder -m "Write a function to parse CSV files"


# List available templates
zeptoclaw template list
```

--------------------------------

### Executed Command Example

Source: https://zeptoclaw.com/docs/guides/plugins

Shows the actual command executed after parameter interpolation.

```bash
curl -X POST 'https://api.example.com' -d '{"key": "value"}'
```

--------------------------------

### Slack Notifier Plugin Example

Source: https://zeptoclaw.com/docs/guides/plugins

An example plugin for sending notifications to Slack.

```json
{
  "name": "slack_notify",
  "description": "Send a notification to a Slack channel",
  "parameters": {
    "type": "object",
    "properties": {
      "channel": {
        "type": "string",
        "description": "Slack channel name"
      },
      "text": {
        "type": "string",
        "description": "Message text"
      }
    },
    "required": ["channel", "text"]
  },
  "command": "curl -X POST https://hooks.slack.com/services/YOUR/WEBHOOK/URL -H 'Content-Type: application/json' -d '{\"channel\": {{channel}}, \"text\": {{text}}}'"
}
```

--------------------------------

### Automated Setup Script

Source: https://zeptoclaw.com/docs/guides/deployment

The fastest way to deploy ZeptoClaw using an interactive wizard.

```bash
curl -fsSL https://zeptoclaw.com/setup.sh | bash
```

--------------------------------

### Validate your configuration

Source: https://zeptoclaw.com/docs/getting-started/quick-start

Check that everything is wired correctly. This validates your config file and reports any issues.

```bash
zeptoclaw config check
```

--------------------------------

### Migrate configuration

Source: https://zeptoclaw.com/docs/reference/cli

Imports configuration and skills from an OpenClaw installation.

```bash
zeptoclaw migrate [OPTIONS]

```

--------------------------------

### Run in gateway mode

Source: https://zeptoclaw.com/docs/getting-started/quick-start

To serve your agent on Telegram, Slack, Discord, or Webhook.

```bash
# Set your channel token
export ZEPTOCLAW_CHANNELS_TELEGRAM_BOT_TOKEN=123456:ABC...


# Start the gateway
zeptoclaw gateway
```

--------------------------------

### Process prompts in batch

Source: https://zeptoclaw.com/docs/getting-started/quick-start

For bulk processing, create a text file with one prompt per line.

```bash
echo "Summarize the Rust ownership model" > prompts.txt
echo "Explain async/await in 3 sentences" >> prompts.txt


zeptoclaw batch --input prompts.txt --format jsonl
```

--------------------------------

### Enable webhook channel

Source: https://zeptoclaw.com/docs/guides/migration

Example ZeptoClaw configuration to enable the webhook channel.

```json
{
  "channels": {
    "webhook": {
      "enabled": true,
      "port": 8080,
      "auth_token": "my-secret"
    }
  }
}

```

--------------------------------

### ZeptoClaw CLI Modes

Source: https://zeptoclaw.com/docs/getting-started/introduction

Examples of how to run ZeptoClaw in different modes: one-shot CLI, gateway, and batch processing.

```bash
# One-shot CLI mode
$ zeptoclaw agent --stream -m "Summarize the last 5 git commits"


# Gateway mode — serves Telegram, Slack, Discord, Webhook
$ zeptoclaw gateway


# Batch mode — process prompts from a file
$ zeptoclaw batch --input prompts.txt --format jsonl
```

--------------------------------

### OpenClaw extension manifest

Source: https://zeptoclaw.com/docs/guides/migration

Example of an OpenClaw extension manifest file (openclaw.plugin.json).

```json
{
  "name": "github-pr",
  "version": "1.0.0",
  "main": "dist/index.js",
  "tools": [{
    "name": "create_pr",
    "description": "Create a GitHub pull request"
  }]
}

```

--------------------------------

### Download binary - Linux x86_64

Source: https://zeptoclaw.com/docs/getting-started/installation

Downloads the pre-built ZeptoClaw binary for Linux x86_64 and makes it executable.

```bash
# Linux x86_64
curl -L https://github.com/qhkm/zeptoclaw/releases/latest/download/zeptoclaw-linux-x86_64 -o zeptoclaw
chmod +x zeptoclaw
```

--------------------------------

### ZeptoClaw plugin manifest

Source: https://zeptoclaw.com/docs/guides/migration

Example of a ZeptoClaw plugin manifest file (plugin.json) in command mode.

```json
{
  "name": "github_pr",
  "description": "Create a GitHub pull request",
  "version": "1.0.0",
  "parameters": {
    "type": "object",
    "properties": {
      "title": { "type": "string", "description": "PR title" },
      "branch": { "type": "string", "description": "Source branch" }
    },
    "required": ["title", "branch"]
  },
  "command": "gh pr create --title {{title}} --head {{branch}} --body 'Created by ZeptoClaw'"
}

```

--------------------------------

### Uninstall Script

Source: https://zeptoclaw.com/docs/guides/deployment

Uninstall ZeptoClaw using the setup script.

```bash
curl -fsSL https://zeptoclaw.com/setup.sh | bash -s -- --uninstall
```

--------------------------------

### Using a custom template

Source: https://zeptoclaw.com/docs/guides/templates

Example of using a custom-defined agent template with the ZeptoClaw CLI.

```bash
zeptoclaw agent --template devops -m "Set up a GitHub Actions pipeline"
```

--------------------------------

### Docker - Run agent mode

Source: https://zeptoclaw.com/docs/getting-started/installation

Runs ZeptoClaw in agent mode using Docker.

```bash
docker pull ghcr.io/qhkm/zeptoclaw:latest
# Run agent mode
docker run --rm ghcr.io/qhkm/zeptoclaw:latest agent -m "Hello"
```

--------------------------------

### Download binary - macOS (Intel)

Source: https://zeptoclaw.com/docs/getting-started/installation

Downloads the pre-built ZeptoClaw binary for macOS with Intel processors and makes it executable.

```bash
# macOS (Intel)
curl -L https://github.com/qhkm/zeptoclaw/releases/latest/download/zeptoclaw-macos-x86_64 -o zeptoclaw
chmod +x zeptoclaw
```

--------------------------------

### Plugin Manifest Example

Source: https://zeptoclaw.com/docs/guides/plugins

A JSON manifest file defining a GitHub pull request tool.

```json
{
  "name": "github_pr",
  "description": "Create a GitHub pull request",
  "version": "1.0.0",
  "parameters": {
    "type": "object",
    "properties": {
      "title": {
        "type": "string",
        "description": "PR title"
      },
      "branch": {
        "type": "string",
        "description": "Source branch"
      }
    },
    "required": ["title", "branch"]
  },
  "command": "gh pr create --title {{title}} --head {{branch}} --body 'Created by ZeptoClaw'"
}
```

--------------------------------

### Docker Deployment Script

Source: https://zeptoclaw.com/docs/guides/deployment

Deploy ZeptoClaw using Docker with the setup script.

```bash
curl -fsSL https://zeptoclaw.com/setup.sh | bash -s -- --docker
```

--------------------------------

### Fallback Provider Configuration

Source: https://zeptoclaw.com/docs/concepts/providers

Example JSON configuration for enabling a fallback provider.

```json
{
  "providers": {
    "anthropic": { "api_key": "sk-ant-..." },
    "openai": { "api_key": "sk-..." },
    "fallback": {
      "enabled": true,
      "provider": "openai"
    }
  }
}
```

--------------------------------

### Download binary - macOS (Apple Silicon)

Source: https://zeptoclaw.com/docs/getting-started/installation

Downloads the pre-built ZeptoClaw binary for macOS with Apple Silicon and makes it executable.

```bash
# macOS (Apple Silicon)
curl -L https://github.com/qhkm/zeptoclaw/releases/latest/download/zeptoclaw-macos-aarch64 -o zeptoclaw
chmod +x zeptoclaw
```

--------------------------------

### Use a template

Source: https://zeptoclaw.com/docs/guides/templates

Example of using a template with the ZeptoClaw CLI to specify an agent's role and a task.

```bash
# Use a template
zeptoclaw agent --template researcher -m "Research Rust async patterns"
```

--------------------------------

### Docker Compose Configuration

Source: https://zeptoclaw.com/docs/guides/deployment

Docker Compose file for multi-service setups.

```yaml
version: '3.8'
services:
  zeptoclaw:
    image: ghcr.io/qhkm/zeptoclaw:latest
    restart: unless-stopped
    environment:
      - ZEPTOCLAW_PROVIDERS_ANTHROPIC_API_KEY=${ANTHROPIC_KEY}
      - ZEPTOCLAW_CHANNELS_TELEGRAM_BOT_TOKEN=${TELEGRAM_TOKEN}
    volumes:
      - zeptoclaw-data:/root/.zeptoclaw
    healthcheck:
      test: ["CMD", "zeptoclaw", "config", "check"]
      interval: 30s
      retries: 3

volumes:
  zeptoclaw-data:
```

--------------------------------

### Systemd Service Management

Source: https://zeptoclaw.com/docs/guides/deployment

Commands to enable and start the ZeptoClaw systemd service.

```bash
sudo systemctl enable zeptoclaw
sudo systemctl start zeptoclaw
```

--------------------------------

### Batch mode with template

Source: https://zeptoclaw.com/docs/guides/templates

Example of running ZeptoClaw in batch mode using a specified agent template.

```bash
zeptoclaw batch --input prompts.txt --template coder
```

--------------------------------

### Sender allowlist configuration

Source: https://zeptoclaw.com/docs/concepts/channels

Example of configuring sender allowlists for the Telegram channel.

```json
{
  "channels": {
    "telegram": {
      "enabled": true,
      "bot_token": "123456:ABC...",
      "deny_by_default": true,
      "allowed_senders": ["user_id_1", "user_id_2"]
    }
  }
}
```

--------------------------------

### Docker - Run gateway mode

Source: https://zeptoclaw.com/docs/getting-started/installation

Runs ZeptoClaw in gateway mode using Docker, mounting a configuration directory and setting an API key.

```bash
docker run -d \
  -v ~/.zeptoclaw:/root/.zeptoclaw \
  -e ZEPTOCLAW_PROVIDERS_ANTHROPIC_API_KEY=sk-... \
  ghcr.io/qhkm/zeptoclaw:latest gateway
```

--------------------------------

### Token Budget Configuration

Source: https://zeptoclaw.com/docs/concepts/agent-loop

Example JSON configuration for setting a token budget for agents.

```json
{
  "agents": {
    "defaults": {
      "token_budget": 100000
    }
  }
}
```

--------------------------------

### Sender Allowlist Configuration

Source: https://zeptoclaw.com/docs/guides/security

Example JSON configuration for a Telegram channel with sender allowlisting enabled.

```json
{
  "channels": {
    "telegram": {
      "enabled": true,
      "bot_token": "...",
      "deny_by_default": true,
      "allow_from": ["123456789"]
    }
  }
}

```

--------------------------------

### Environment Variables for Providers

Source: https://zeptoclaw.com/docs/concepts/providers

Example environment variables for configuring API keys, custom base URLs, retry settings, and fallback providers.

```bash
# API keys
ZEPTOCLAW_PROVIDERS_ANTHROPIC_API_KEY=...
ZEPTOCLAW_PROVIDERS_OPENAI_API_KEY=...
ZEPTOCLAW_PROVIDERS_OPENROUTER_API_KEY=...
ZEPTOCLAW_PROVIDERS_GROQ_API_KEY=...
ZEPTOCLAW_PROVIDERS_OLLAMA_API_KEY=...
ZEPTOCLAW_PROVIDERS_VLLM_API_KEY=...
ZEPTOCLAW_PROVIDERS_GEMINI_API_KEY=...
ZEPTOCLAW_PROVIDERS_NVIDIA_API_KEY=...
ZEPTOCLAW_PROVIDERS_ZHIPU_API_KEY=...


# Custom base URLs
ZEPTOCLAW_PROVIDERS_OPENAI_API_BASE=...
ZEPTOCLAW_PROVIDERS_OLLAMA_API_BASE=...


# Retry
ZEPTOCLAW_PROVIDERS_RETRY_ENABLED=true
ZEPTOCLAW_PROVIDERS_RETRY_MAX_RETRIES=3
ZEPTOCLAW_PROVIDERS_RETRY_BASE_DELAY_MS=1000
ZEPTOCLAW_PROVIDERS_RETRY_MAX_DELAY_MS=30000


# Fallback
ZEPTOCLAW_PROVIDERS_FALLBACK_ENABLED=true
ZEPTOCLAW_PROVIDERS_FALLBACK_PROVIDER=openai
```

--------------------------------

### Agent Timeout Configuration

Source: https://zeptoclaw.com/docs/concepts/agent-loop

Environment variable example for configuring the agent-level timeout.

```bash
export ZEPTOCLAW_AGENTS_DEFAULTS_AGENT_TIMEOUT_SECS=600
```

--------------------------------

### Store memory in ZeptoClaw

Source: https://zeptoclaw.com/docs/guides/migration

Example command to store structured data in ZeptoClaw's long-term memory.

```bash
Store this: my preferred language is Rust, category: preferences

```

--------------------------------

### List available tools

Source: https://zeptoclaw.com/docs/reference/cli

Lists all available tools and their status.

```bash
zeptoclaw tools list

```

--------------------------------

### List channels

Source: https://zeptoclaw.com/docs/reference/cli

Lists all configured channels.

```bash
zeptoclaw channel list

```

--------------------------------

### Tools command

Source: https://zeptoclaw.com/docs/reference/cli

Discover available tools.

```bash
zeptoclaw tools <SUBCOMMAND>
```

--------------------------------

### Show tool information

Source: https://zeptoclaw.com/docs/reference/cli

Shows detailed information about a specific tool.

```bash
zeptoclaw tools info <NAME>

```

--------------------------------

### Template list command

Source: https://zeptoclaw.com/docs/reference/cli

List all available templates (built-in and custom).

```bash
zeptoclaw template list
```

--------------------------------

### Template show command

Source: https://zeptoclaw.com/docs/reference/cli

Show template details including system prompt, model, and overrides.

```bash
zeptoclaw template show <NAME>
```

--------------------------------

### History show command

Source: https://zeptoclaw.com/docs/reference/cli

Show a session by fuzzy-matching the query against session titles and keys.

```bash
zeptoclaw history show <QUERY>
```

--------------------------------

### List available templates

Source: https://zeptoclaw.com/docs/guides/templates

Command to list all available agent templates in ZeptoClaw.

```bash
# List available templates
zeptoclaw template list
```

--------------------------------

### Global options

Source: https://zeptoclaw.com/docs/reference/cli

Global options for the ZeptoClaw CLI.

```bash
zeptoclaw [OPTIONS] <COMMAND>
```

--------------------------------

### Verify skills loaded

Source: https://zeptoclaw.com/docs/guides/migration

Command to list skills in ZeptoClaw to verify they have loaded correctly.

```bash
zeptoclaw skills list

```

--------------------------------

### Template command

Source: https://zeptoclaw.com/docs/reference/cli

Manage agent templates.

```bash
zeptoclaw template <SUBCOMMAND>
```

--------------------------------

### Fly.io Deployment Commands

Source: https://zeptoclaw.com/docs/guides/deployment

Commands to launch, set secrets, and deploy to Fly.io.

```bash
fly launch
fly secrets set ZEPTOCLAW_PROVIDERS_ANTHROPIC_API_KEY=sk-ant-...
fly secrets set ZEPTOCLAW_CHANNELS_TELEGRAM_BOT_TOKEN=123456:ABC...
fly deploy
```

--------------------------------

### Fly.io Configuration

Source: https://zeptoclaw.com/docs/guides/deployment

Configuration file for deploying to Fly.io.

```hcl
app = "my-zeptoclaw"
primary_region = "sin"


[build]
  image = "ghcr.io/qhkm/zeptoclaw:latest"


[env]
  RUST_LOG = "info"


[[services]]
  internal_port = 8080
  protocol = "tcp"


  [[services.ports]]
    port = 443
    handlers = ["tls", "http"]
```

--------------------------------

### Show template details

Source: https://zeptoclaw.com/docs/guides/templates

Command to display detailed information about a specific agent template.

```bash
# Show template details
zeptoclaw template show coder
```

--------------------------------

### Docker Run Command

Source: https://zeptoclaw.com/docs/guides/deployment

Run a ZeptoClaw container with environment variables.

```bash
docker build -t my-agent .
docker run -d --name zeptoclaw \
  -e ZEPTOCLAW_PROVIDERS_ANTHROPIC_API_KEY=sk-ant-...
  -e ZEPTOCLAW_CHANNELS_TELEGRAM_BOT_TOKEN=123456:ABC...
  my-agent
```

--------------------------------

### Groq configuration (Environment Variable)

Source: https://zeptoclaw.com/docs/concepts/providers

Configuration for the Groq provider using environment variables.

```bash
export ZEPTOCLAW_PROVIDERS_GROQ_API_KEY=gsk_...
```

--------------------------------

### Enabling Coding Tools

Source: https://zeptoclaw.com/docs/concepts/tools

The `grep` and `find` tools are disabled by default for portability. They can be enabled using the `coder` template, by setting `tools.coding_tools: true` in `~/.zeptoclaw/config.json`, or by setting the `ZEPTOCLAW_TOOLS_CODING_TOOLS=true` environment variable.

```bash
zeptoclaw agent --template coder -m "..."
```

```json
{
  "tools": {
    "coding_tools": true
  }
}
```

```bash
export ZEPTOCLAW_TOOLS_CODING_TOOLS=true
```

--------------------------------

### Skills command

Source: https://zeptoclaw.com/docs/reference/cli

Manage agent skills.

```bash
zeptoclaw skills list
```

--------------------------------

### Manage channels

Source: https://zeptoclaw.com/docs/reference/cli

Top-level command for managing notification channels.

```bash
zeptoclaw channel <SUBCOMMAND>

```

--------------------------------

### Agent command

Source: https://zeptoclaw.com/docs/reference/cli

Run a single agent interaction.

```bash
zeptoclaw agent [OPTIONS] -m <MESSAGE>
```

--------------------------------

### Google Gemini configuration (Environment Variable)

Source: https://zeptoclaw.com/docs/concepts/providers

Configuration for the Google Gemini provider using environment variables.

```bash
export ZEPTOCLAW_PROVIDERS_GEMINI_API_KEY=AIza...
```

--------------------------------

### History list command

Source: https://zeptoclaw.com/docs/reference/cli

List recent sessions with timestamps and titles.

```bash
zeptoclaw history list [--limit <N>]
```

--------------------------------

### Batch command

Source: https://zeptoclaw.com/docs/reference/cli

Process multiple prompts from a file.

```bash
zeptoclaw batch [OPTIONS] --input <FILE>
```

--------------------------------

### Automated Migration Commands

Source: https://zeptoclaw.com/docs/guides/migration

Commands to preview or run the automated migration process from OpenClaw to ZeptoClaw.

```bash
# Preview what would be migrated (no changes made)
zeptoclaw migrate --dry-run
```

```bash
# Run the migration interactively
zeptoclaw migrate
```

```bash
# Accept all defaults and specify a custom OpenClaw path
zeptoclaw migrate --from ~/.openclaw --yes
```

--------------------------------

### Copy skills directory

Source: https://zeptoclaw.com/docs/guides/migration

Command to manually copy skills from the OpenClaw directory to the ZeptoClaw directory.

```bash
cp -r ~/.openclaw/skills/* ~/.zeptoclaw/skills/

```

--------------------------------

### Test a channel

Source: https://zeptoclaw.com/docs/reference/cli

Tests a configured notification channel.

```bash
zeptoclaw channel test <NAME>

```

--------------------------------

### NVIDIA NIM configuration (Environment Variable)

Source: https://zeptoclaw.com/docs/concepts/providers

Configuration for the NVIDIA NIM provider using environment variables.

```bash
export ZEPTOCLAW_PROVIDERS_NVIDIA_API_KEY=nvapi-...
```

--------------------------------

### Watch a URL for changes

Source: https://zeptoclaw.com/docs/reference/cli

Monitors a URL for changes with options for interval and notifications.

```bash
zeptoclaw watch <URL> [OPTIONS]

```

--------------------------------

### OpenAI configuration (Environment Variable)

Source: https://zeptoclaw.com/docs/concepts/providers

Configuration for the OpenAI provider using environment variables.

```bash
export ZEPTOCLAW_PROVIDERS_OPENAI_API_KEY=sk-...
```

--------------------------------

### Memory stats command

Source: https://zeptoclaw.com/docs/reference/cli

Display memory statistics.

```bash
zeptoclaw memory stats
```

--------------------------------

### Secrets command

Source: https://zeptoclaw.com/docs/reference/cli

Manage secret encryption at rest.

```bash
zeptoclaw secrets <SUBCOMMAND>
```

--------------------------------

### ZeptoClaw Provider Smoke Test

Source: https://zeptoclaw.com/docs/guides/migration

A quick command to test ZeptoClaw provider functionality.

```bash
# Quick smoke test
zeptoclaw agent -m "hello"
```

--------------------------------

### Gateway command

Source: https://zeptoclaw.com/docs/concepts/channels

Run all configured channels simultaneously with the gateway command.

```bash
zeptoclaw gateway
```

--------------------------------

### Systemd Service File

Source: https://zeptoclaw.com/docs/guides/deployment

Systemd unit file for running ZeptoClaw as a service.

```ini
[Unit]
Description=ZeptoClaw AI Agent
After=network-online.target


[Service]
Type=simple
User=zeptoclaw
ExecStart=/usr/local/bin/zeptoclaw gateway
Restart=always
RestartSec=5
Environment=RUST_LOG=info
EnvironmentFile=/etc/zeptoclaw/env


[Install]
WantedBy=multi-user.target
```

--------------------------------

### OpenRouter configuration (Environment Variable)

Source: https://zeptoclaw.com/docs/concepts/providers

Configuration for the OpenRouter provider using environment variables.

```bash
export ZEPTOCLAW_PROVIDERS_OPENROUTER_API_KEY=sk-or-...
```

--------------------------------

### Secrets encrypt command

Source: https://zeptoclaw.com/docs/reference/cli

Encrypt plaintext API keys and tokens in your config file using XChaCha20-Poly1305.

```bash
zeptoclaw secrets encrypt
```

--------------------------------

### Ollama configuration (Environment Variable)

Source: https://zeptoclaw.com/docs/concepts/providers

Configuration for the Ollama provider using environment variables.

```bash
export ZEPTOCLAW_PROVIDERS_OLLAMA_API_KEY=ollama
```

--------------------------------

### History command

Source: https://zeptoclaw.com/docs/reference/cli

Manage conversation history.

```bash
zeptoclaw history <SUBCOMMAND>
```

--------------------------------

### Secrets rotate command

Source: https://zeptoclaw.com/docs/reference/cli

Re-encrypt with a new master key.

```bash
zeptoclaw secrets rotate
```

--------------------------------

### File location

Source: https://zeptoclaw.com/docs/reference/configuration

The directory structure for ZeptoClaw configuration and data files.

```shell
~/.zeptoclaw/
├── config.json        # Main configuration
├── memory/
│   └── longterm.json  # Long-term memory store
├── sessions/          # Conversation history
├── skills/            # Custom skills (markdown)
└── plugins/           # Custom plugins (JSON manifests)

```

--------------------------------

### Memory list command

Source: https://zeptoclaw.com/docs/reference/cli

List memories with optional category filtering.

```bash
zeptoclaw memory list [--category <CATEGORY>]
```

--------------------------------

### Container Isolation Commands

Source: https://zeptoclaw.com/docs/guides/security

Commands to enable and configure container isolation for ZeptoClaw gateway.

```bash
# Auto-detect runtime
zeptoclaw gateway --containerized


# Force Docker
zeptoclaw gateway --containerized docker


# Force Apple Container (macOS 15+)
zeptoclaw gateway --containerized apple
```

--------------------------------

### Memory search command

Source: https://zeptoclaw.com/docs/reference/cli

Search memories by query.

```bash
zeptoclaw memory search <QUERY>
```

--------------------------------

### Groq configuration (JSON)

Source: https://zeptoclaw.com/docs/concepts/providers

Configuration for the Groq provider using JSON.

```json
{
  "providers": {
    "groq": {
      "api_key": "gsk_..."
    }
  },
  "agents": {
    "defaults": {
      "model": "mixtral-8x7b-32768"
    }
  }
}
```

--------------------------------

### Heartbeat command

Source: https://zeptoclaw.com/docs/reference/cli

View heartbeat service status.

```bash
zeptoclaw heartbeat --show
```

--------------------------------

### Dockerfile for Single Container

Source: https://zeptoclaw.com/docs/guides/deployment

Dockerfile to build a ZeptoClaw Docker image.

```dockerfile
FROM ghcr.io/qhkm/zeptoclaw:latest

COPY config.json /root/.zeptoclaw/config.json

EXPOSE 8080
CMD ["zeptoclaw", "gateway"]
```

--------------------------------

### Container isolation options

Source: https://zeptoclaw.com/docs/concepts/channels

Run the gateway in containerized mode, with options to auto-detect, force Docker, or force Apple Container.

```bash
# Auto-detect container runtime
zeptoclaw gateway --containerized


# Force Docker
zeptoclaw gateway --containerized docker


# Force Apple Container (macOS 15+)
zeptoclaw gateway --containerized apple
```

--------------------------------

### Memory set command

Source: https://zeptoclaw.com/docs/reference/cli

Set a memory key-value pair with optional category and tags.

```bash
zeptoclaw memory set <KEY> <VALUE> [--category <CATEGORY>] [--tags <TAGS>]
```

--------------------------------

### VLLM configuration (JSON)

Source: https://zeptoclaw.com/docs/concepts/providers

Configuration for the VLLM provider using JSON.

```json
{
  "providers": {
    "vllm": {
      "api_key": "vllm"
    }
  },
  "agents": {
    "defaults": {
      "model": "meta-llama/Llama-2-7b-hf"
    }
  }
}
```

--------------------------------

### Anthropic configuration (Environment Variable)

Source: https://zeptoclaw.com/docs/concepts/providers

Configuration for the Anthropic provider using environment variables.

```bash
export ZEPTOCLAW_PROVIDERS_ANTHROPIC_API_KEY=sk-ant-...
```

--------------------------------

### Memory command

Source: https://zeptoclaw.com/docs/reference/cli

Manage long-term memory from the CLI.

```bash
zeptoclaw memory <SUBCOMMAND>
```

--------------------------------

### Custom API base URL for OpenAI (Environment Variable)

Source: https://zeptoclaw.com/docs/concepts/providers

Overriding the default base URL for the OpenAI provider using environment variables.

```bash
export ZEPTOCLAW_PROVIDERS_OPENAI_API_BASE=https://my-proxy.example.com/v1
```

--------------------------------

### Webhook channel configuration

Source: https://zeptoclaw.com/docs/concepts/channels

Configure the webhook channel with bind address, port, and authentication token.

```json
{
  "channels": {
    "webhook": {
      "enabled": true,
      "bind": "0.0.0.0",
      "port": 8080,
      "auth_token": "my-secret-token"
    }
  }
}
```

--------------------------------

### Streaming Command

Source: https://zeptoclaw.com/docs/concepts/providers

Command-line interface command to enable streaming output from the agent.

```bash
zeptoclaw agent --stream -m "Tell me a story"
```

--------------------------------

### OpenAI configuration (JSON)

Source: https://zeptoclaw.com/docs/concepts/providers

Configuration for the OpenAI provider using JSON.

```json
{
  "providers": {
    "openai": {
      "api_key": "sk-..."
    }
  }
}
```

--------------------------------

### Prompt Injection Detection Configuration

Source: https://zeptoclaw.com/docs/guides/security

Environment variable to enable or disable the prompt injection detection safety layer.

```bash
export ZEPTOCLAW_SAFETY_ENABLED=true  # default
```

--------------------------------

### Tool Approval Gate Configuration

Source: https://zeptoclaw.com/docs/guides/security

JSON configuration for the tool approval gate, specifying which tools require approval and which can be auto-approved.

```json
{
  "approval": {
    "enabled": true,
    "require_approval": ["shell", "write_file", "delegate"],
    "auto_approve": ["read_file", "memory", "web_search"]
  }
}
```

--------------------------------

### Render Configuration

Source: https://zeptoclaw.com/docs/guides/deployment

Render configuration for a ZeptoClaw worker service.

```yaml
services:
  - type: worker
    name: zeptoclaw
    runtime: docker
    dockerfilePath: ./Dockerfile
    envVars:
      - key: ZEPTOCLAW_PROVIDERS_ANTHROPIC_API_KEY
        sync: false
      - key: ZEPTOCLAW_CHANNELS_TELEGRAM_BOT_TOKEN
        sync: false
```

--------------------------------

### NVIDIA NIM configuration (JSON)

Source: https://zeptoclaw.com/docs/concepts/providers

Configuration for the NVIDIA NIM provider using JSON.

```json
{
  "providers": {
    "nvidia": {
      "api_key": "nvapi-..."
    }
  },
  "agents": {
    "defaults": {
      "model": "meta/llama-3.1-8b-instruct"
    }
  }
}
```

--------------------------------

### Railway Deployment Commands

Source: https://zeptoclaw.com/docs/guides/deployment

Commands to initialize, deploy, and set secrets via Railway CLI.

```bash
railway init
railway up

# Set secrets
railway variables set ZEPTOCLAW_PROVIDERS_ANTHROPIC_API_KEY=sk-ant-...
railway variables set ZEPTOCLAW_CHANNELS_TELEGRAM_BOT_TOKEN=123456:ABC...
```

--------------------------------

### Secret Encryption Commands

Source: https://zeptoclaw.com/docs/guides/security

Commands to encrypt, decrypt, and rotate secrets for Zeptoclaw.

```bash
# Encrypt all plaintext secrets
zeptoclaw secrets encrypt

```

```bash
# Decrypt for editing
zeptoclaw secrets decrypt

```

```bash
# Rotate to a new master key
zeptoclaw secrets rotate

```
Tokens:
Raw