clawlet

module
v0.2.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 12, 2026 License: MIT

README

clawlet

clawlet: Lightweight Personal AI Assistant
Single Binary, Simple Setup

This project is inspired by OpenClaw and nanobot.

Why clawlet

📦 Single binary, small footprint: Runs as one executable with minimal moving parts.

📖 Readable: Straightforward organization so it’s easy to understand, modify, and extend.

Easy to adopt: onboard creates a ready-to-edit workspace and config; you can start chatting immediately.

Install

Prebuilt binaries are published on GitHub Releases (via GoReleaser).

macOS example (Apple Silicon):

curl -L -o clawlet.tar.gz \
  https://github.com/mosaxiv/clawlet/releases/latest/download/clawlet_Darwin_arm64.tar.gz
tar -xzf clawlet.tar.gz
chmod +x clawlet
mkdir -p ~/.local/bin
mv clawlet ~/.local/bin/
clawlet --help

Quick Start

# Initialize
clawlet onboard \
  --openrouter-api-key "sk-or-..." \
  --model "openrouter/anthropic/claude-sonnet-4.5"

# Check effective configuration
clawlet status

# Chat
clawlet agent -m "What is 2+2?"

Architecture

flowchart LR
    ChatApps["Chat Apps / CLI"]

    %% Agent loop (Message -> LLM <-> Tools -> Response)
    subgraph Loop["Agent Loop"]
      Msg[Message]
      LLM[LLM]
      Tools[Tools]
      Resp[Response]
      Sess["Sessions"]
    end

    subgraph Ctx["Context"]
      CtxHub["Files, Memory, Skills"]
    end

    ChatApps --> Msg
    Msg --> LLM
    LLM -->|tool calls| Tools
    Tools -->|tool results| LLM
    LLM --> Resp

    Tools <--> CtxHub
    %% Sessions are internal state (history in/out)
    Sess -.-> LLM
    Msg -.-> Sess
    Resp -.-> Sess

    %% Conversation continues (next turn)
    Resp --> ChatApps
    Resp -.-> Msg

    %% Color blocks (similar to the reference diagram)
    classDef chat fill:#dbeafe,stroke:#60a5fa,color:#111827;
    classDef msg fill:#fef3c7,stroke:#f59e0b,color:#111827;
    classDef loop fill:#fed7aa,stroke:#fb923c,color:#111827;
    classDef resp fill:#fecaca,stroke:#f87171,color:#111827;
    classDef ctx fill:#e9d5ff,stroke:#a78bfa,color:#111827;

    class ChatApps chat;
    class Msg msg;
    class LLM,Tools loop;
    class Resp resp;
    class CtxHub,Sess ctx;

Workspace (How clawlet “thinks”)

Default workspace: ~/.clawlet/workspace (override with --workspace or CLAWLET_WORKSPACE).

Files in the workspace are automatically injected into the system prompt when present:

  • AGENTS.md: contributor/user instructions for the agent
  • SOUL.md, USER.md, IDENTITY.md: personalization and guardrails
  • TOOLS.md: tool reference for humans
  • HEARTBEAT.md: periodic tasks
  • memory/: long-term and daily notes

This matches the “workspace-first” style: you control behavior by editing small, versionable text files.

Configuration (~/.clawlet/config.json)

Config file: ~/.clawlet/config.json

Supported providers

clawlet currently supports these LLM providers:

  • OpenAI (openai/<model>, API key: env.OPENAI_API_KEY)
  • OpenRouter (openrouter/<provider>/<model>, API key: env.OPENROUTER_API_KEY)
  • Anthropic (anthropic/<model>, API key: env.ANTHROPIC_API_KEY)
  • Gemini (gemini/<model>, API key: env.GEMINI_API_KEY or env.GOOGLE_API_KEY)
  • Local (Ollama / vLLM / OpenAI-compatible local endpoint) (ollama/<model> or local/<model>, default base URL: http://localhost:11434/v1, API key optional)

Minimal config (OpenRouter):

{
  "env": { "OPENROUTER_API_KEY": "sk-or-..." },
  "agents": { "defaults": { "model": "openrouter/anthropic/claude-sonnet-4-5" } }
}

Agent generation defaults are configurable (aligned with nanobot defaults):

{
  "agents": {
    "defaults": {
      "model": "openrouter/anthropic/claude-sonnet-4-5",
      "maxTokens": 8192,
      "temperature": 0.7
    }
  }
}

Minimal config (Local via Ollama):

{
  "agents": { "defaults": { "model": "ollama/qwen2.5:14b" } }
}

Minimal config (Local via vLLM using the same ollama/ route):

{
  "agents": { "defaults": { "model": "ollama/meta-llama/Llama-3.1-8B-Instruct" } },
  "llm": { "baseURL": "http://localhost:8000/v1" }
}

clawlet will fill in sensible defaults for missing sections (tools, gateway, cron, heartbeat, channels).

Safety defaults

clawlet is conservative by default:

  • tools.restrictToWorkspace defaults to true (tools can only access files inside the workspace directory)

Chat Apps

Chat app integrations are configured under channels (examples below).

Discord
  1. Create the bot and copy the token Go to https://discord.com/developers/applications, create an application, then BotAdd Bot. Copy the bot token.

  2. Invite the bot to your server (OAuth2 URL Generator) In OAuth2URL Generator, choose Scopes: bot. For Bot Permissions, the minimal set is View Channels, Send Messages, Read Message History. Open the generated URL and add the bot to your server.

  3. Enable Message Content Intent (required for guild message text) In the Developer Portal bot settings, enable MESSAGE CONTENT INTENT. Without it, the bot won't receive message text in servers.

  4. Get your User ID (for allowFrom) Enable Developer Mode in Discord settings, then right-click your profile and select Copy User ID.

  5. Configure clawlet channels.discord.allowFrom is the list of user IDs allowed to talk to the agent (empty = allow everyone).

Example config (merge into ~/.clawlet/config.json):

{
  "channels": {
    "discord": {
      "enabled": true,
      "token": "YOUR_BOT_TOKEN",
      "allowFrom": ["YOUR_USER_ID"]
    }
  }
}
  1. Run
clawlet gateway
Slack

Uses Socket Mode (no public URL required). clawlet currently supports Socket Mode only.

  1. Create a Slack app
  2. Configure the app:
    • Socket Mode: ON, generate an App-Level Token (xapp-...) with connections:write
    • OAuth scopes (bot): chat:write, reactions:write, app_mentions:read, im:history, channels:history
    • Event Subscriptions: subscribe to message.im, message.channels, app_mention
  3. Install the app to your workspace and copy the Bot Token (xoxb-...)
  4. Set channels.slack.enabled=true, and configure botToken + appToken.
    • groupPolicy: "mention" (default — respond only when @mentioned), "open" (respond to all channel messages), or "allowlist" (restrict to specific channels).
    • DM policy defaults to open. Set "dm": {"enabled": false} to disable DMs.

Example config (merge into ~/.clawlet/config.json):

{
  "channels": {
    "slack": {
      "enabled": true,
      "botToken": "xoxb-...",
      "appToken": "xapp-...",
      "groupPolicy": "mention",
      "allowFrom": ["U012345"]
    }
  }
}

Then run:

clawlet gateway

CLI Reference

Command Description
clawlet onboard Initialize a workspace and write a minimal config.
clawlet status Print the effective configuration (after defaults and routing).
clawlet agent Run the agent in CLI mode (interactive or single message).
clawlet gateway Run the long-lived gateway (channels + cron + heartbeat).
clawlet channels status Show which chat channels are enabled/configured.
clawlet cron list List scheduled jobs.
clawlet cron add Add a scheduled job.
clawlet cron remove Remove a scheduled job.
clawlet cron toggle Enable/disable a scheduled job.
clawlet cron run Run a job immediately.

clawlet cron add formats

--message is required, and exactly one of --every, --cron, or --at must be set.

# Every N seconds
clawlet cron add --message "summarize my inbox" --every 3600

# Cron expression (5-field)
clawlet cron add --message "daily standup notes" --cron "0 9 * * 1-5"

# Run once at a specific time (RFC3339)
clawlet cron add --message "remind me" --at "2026-02-10T09:00:00Z"

# Deliver to a chat (requires both --channel and --to)
clawlet cron add --message "ping" --every 600 --channel slack --to U012345

Directories

Path Synopsis
cmd
clawlet command

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL