| name | honcho-setup |
| description | Install the @honcho-ai/openclaw-honcho plugin and run initial setup. Runs `openclaw plugins install`, `openclaw honcho setup` (which prompts for your API key and migrates any legacy memory files to Honcho), and restarts the gateway. **UPLOADS WORKSPACE CONTENT TO EXTERNAL API** via `openclaw honcho setup`: sends USER.md, MEMORY.md, IDENTITY.md, memory/, canvas/, SOUL.md, AGENTS.md, BOOTSTRAP.md, TOOLS.md to api.honcho.dev (managed, default) or your self-hosted HONCHO_BASE_URL. HEARTBEAT.md is excluded. Requires explicit interactive user confirmation before uploading, even when HONCHO_API_KEY is pre-set. No workspace or memory files are deleted, moved, or modified. `openclaw honcho setup` writes plugin configuration to ~/.openclaw/openclaw.json. After setup, the plugin persistently observes conversations and transmits data to Honcho across sessions; disable with `openclaw plugins disable openclaw-honcho`.
|
| metadata | {"openclaw":{"emoji":"🧠","required_env":[],"optional_env":[{"name":"HONCHO_API_KEY","description":"Required for managed Honcho (https://app.honcho.dev). If set, the setup command skips the API key prompt but still requires explicit user confirmation before any data upload. If not set, the setup command will prompt for it interactively."},{"name":"HONCHO_BASE_URL","description":"Base URL for a self-hosted Honcho instance (e.g. http://localhost:8000). Defaults to https://api.honcho.dev (managed)."}],"required_binaries":["node","npm"],"writes_to_disk":true,"reads_sensitive_files":["~/.openclaw/openclaw.json - read and updated by openclaw honcho setup; API key collected via interactive prompt and written here"],"network_access":["api.honcho.dev (managed mode, default)","User-configured HONCHO_BASE_URL (self-hosted mode)"],"data_handling":{"uploads_to_external":true,"requires_user_confirmation":true,"deletes_files":false,"modifies_files":false,"external_destinations":["api.honcho.dev (managed Honcho, default)","User-configured HONCHO_BASE_URL (self-hosted mode)"],"uploaded_content":["USER.md, MEMORY.md (user profile/memory files)","All files under memory/ directory (structured memory)","All files under canvas/ directory (working memory)","SOUL.md, IDENTITY.md, AGENTS.md, BOOTSTRAP.md, TOOLS.md (agent configuration)","HEARTBEAT.md excluded — it is a live task queue, not memory"],"data_destination_purpose":"Migrates file-based memory system to Honcho API for AI agent memory/personalization"}},"homepage":"https://honcho.dev","source":"https://github.com/plastic-labs/honcho"} |
Honcho Setup
Install the @honcho-ai/openclaw-honcho plugin. The plugin includes openclaw honcho setup, which handles API key configuration and migration of any legacy memory files to Honcho.
⚠️ DATA UPLOAD WARNING: openclaw honcho setup (run in Step 2) will offer to upload your workspace memory files (USER.md, MEMORY.md, IDENTITY.md, memory/, canvas/, SOUL.md, AGENTS.md, BOOTSTRAP.md, TOOLS.md) to an external API. HEARTBEAT.md is excluded. By default, data is sent to api.honcho.dev. For self-hosted instances, data is sent to your configured HONCHO_BASE_URL. The setup command will show exactly which files will be uploaded and ask for explicit confirmation before proceeding.
No local files are deleted, moved, or modified. Originals remain exactly in place.
Step 1: Install the Plugin
Install the Honcho plugin using the OpenClaw plugin system. Use this exact command — do not install @honcho-ai/sdk directly or use npm install in the workspace.
openclaw plugins install @honcho-ai/openclaw-honcho
Then enable it:
openclaw plugins enable openclaw-honcho
Verify the plugin loaded without errors. If the gateway logs show Cannot find module '@honcho-ai/sdk', install dependencies manually:
cd ~/.openclaw/extensions/openclaw-honcho && npm install
This is a known issue with the OpenClaw plugin installer not running dependency resolution for plugin packages.
Step 2: Run Setup
Run the setup command that ships with the plugin:
openclaw honcho setup
This command will:
- Prompt interactively for your Honcho API key
- Write configuration to
~/.openclaw/openclaw.json
- Scan for legacy memory files and offer to migrate them to Honcho
Follow the prompts. Migration is optional — if you have no legacy files or want to skip, you can skip the upload step.
For managed Honcho, you need an API key from https://app.honcho.dev. For self-hosted instances, set HONCHO_BASE_URL to your instance URL and the API key is optional.
