AiBOX.im

AiDog

Self-hosted personal AI companion — talks to you on Telegram, Feishu and DingTalk, managed from a local web console

WindowsmacOS Difficulty ●●●●○ experimental v0.5.87
AiDog icon

AiDog · icon from the registry

System requirements

No extra runtime needed

This app ships with everything it needs — no Node.js, Python or other runtimes to install.

Platforms

WindowsmacOS

Self-hosted personal AI companion — talks to you on Telegram, Feishu and DingTalk, managed from a local web console

Registry data updated: 2026-11-12

Config & data

Config file written to

~/aidog/web/settings.json

  • ~/aidog

Everything stays on your own machine — nothing is uploaded. To uninstall, delete these folders.

Install in three steps

  1. 01

    Install AiBOX

    One portable file for Windows (macOS coming). Double-click and it runs — no installer, no administrator rights.

    Go to download →
  2. 02

    Pick AiDog

    Open the AiBOX app catalog, find AiDog and press Install. AiBOX checks what your machine already has and installs only what is missing.

  3. 03

    Follow the wizard

    It downloads with a checksum check, writes the config and fills in your API key if the app needs one. You just click.

    ✓ Installed until it works.

Prefer to do it by hand? The full written guide is right below. Read the guide ↓

Install guide

The same steps in written form — follow along at your own pace.

One line: AiDog (aidog.im) is a personal AI companion that runs entirely on your own machine — it talks to you over Telegram, Feishu, DingTalk and other channels, ships with a skill system, natural-language cron jobs and a self-evolving memory; your credentials never leave your computer and there is no cloud account.

What you get

  • A resident local assistant: loopback web console (127.0.0.1:19167) plus messenger channels
  • Skills with a deterministic router, subagents, natural-language scheduling (/cron), memory evolution (/learn, /reflect)
  • Completely free, no telemetry (optional anonymous usage counting is off by default) — you only bring a model endpoint

Before you start (5 minutes)

NeedNotes
WindowsRequires WSL2 (e.g. Ubuntu). The AiDog runtime officially lives inside WSL; the native Windows shell is attach-only
macOSUpstream marks it "expected-but-untested" — installable as an experiment, issues are possible (experimental support)
Python 3.10+Usually preinstalled in WSL/Ubuntu: check with python3 --version
tmuxNeeds administrator rights: run sudo apt-get install tmux inside WSL yourself — AiBOX never escalates privileges for you
Model endpointAny OpenAI-compatible endpoint (there is also a zero-config local gateway for trying out)
Telegram etc.Optional: a bot token if you want messenger channels
⚠️ Windows trap: the repository must be cloned onto WSL's own filesystem (e.g. ~/aidog), never onto a mounted C:\ drive — 9p/CIFS mounts reject chmod and break tmux; copying a Windows-side clone in also breaks the .sh scripts with CRLF line endings.

Install

Route A: install with AiBOX (recommended)

  1. Open AiBOX → app directory → AiDog → Install
  2. AiBOX downloads the hash-verified official source archive (accelerated automatically in CN), unpacks it to ~/aidog inside WSL and runs the official one-command installer deploy/install.sh (provision + boot + verify; safe to re-run)
  3. When the installer reports, continue with configuration below

Route B: manual install (official commands)

WSL / Linux (same on macOS):

# Install tmux first (requires admin, do it manually)
sudo apt-get install tmux          # Ubuntu/WSL; on macOS use brew install tmux

git clone https://github.com/AiDog-im/AiDog.git aidog && cd aidog
bash deploy/install.sh             # one command: provision + boot + verify
aidog setup                        # guided wizard: fills only the missing slots

Configuration (make it talk)

aidog setup only prompts for slots that are still empty (hidden input, values are never echoed):

  1. WEB_TOKEN: a console write token — any long random string you invent
  2. Model endpoint: in the console Settings or the wizard, set an OpenAI-compatible base_url + model (default is the local gateway http://127.0.0.1:3460/v1, model mimo-v2.6-flash; fill MODEL_API_KEY only if your provider needs a key)
  3. Telegram (optional): a token from @BotFather + your numeric user id (allowlist — strangers are rejected)

Verification: what "success" looks like

  1. aidog setup --check exits 0 (fully ready) or 2 (only credentials pending) — never 1
  2. Open http://127.0.0.1:19167, send a message in the chat card — a streamed reply means the model chain is live
  3. Message your bot /help from an allowlisted Telegram account and get a reply
  4. python3 ~/aidog/deploy/aidog_doctor.py: zero FAILs

FAQ

  • tmux not found: install tmux manually (admin required, see above), then re-run bash deploy/install.sh
  • port 19167 is used: boot on another port: AIDOG_WEB_PORT=19200 bash deploy/boot_services.sh start
  • Stays PENDING / model endpoint unreachable: the brain isn't reachable yet. Make sure mycore.base_url in web/settings.json responds; exit code 2 with nothing configured is an honest "not configured yet", not a crash
  • Telegram messages not arriving: often blocked egress — the runtime routes bot traffic through a local proxy (HTTPS_PROXY); set it in the shell that starts the tmux sessions
  • aidog update apply refuses with a dirty tree: by design — commit local changes before upgrading

Uninstall

bash ~/aidog/deploy/boot_services.sh stop   # stop the runtime first
rm -rf ~/aidog                              # machine-local state lives beside the code — back up secrets.env and data/ first
rm -f ~/.local/bin/aidog                    # remove the CLI wrapper

More: official installation docs · aidog.im

Model / API key setup

AiBOX fills this in for you during the wizard — this section is for setting it up by hand.

Any OpenAI-compatible endpoint

Local model — no API key needed.

~/aidog/web/settings.json

Common questions

Which platforms does AiDog run on?

Runs on Windows / macOS — install it with AiBOX on any of them.

How hard is AiDog to install?

Difficulty 4 out of 5. AiBOX does the download and setup; your part is clicking through the wizard and pasting a key if the app needs one.

Where does AiDog keep my data?

Everything stays on your own machine: ~/aidog. To uninstall, delete these — nothing is ever uploaded.

Something not working?

An outdated step, an error you do not understand, a typo — tell us and we will fix this page.

Report a problem →

Version & updates

Current version
v0.5.87
Registry data updated
2026-11-12

Version numbers are re-checked by our daily probe — when upstream ships a new release, this page follows.

Questions or problems?

A wrong step, a confusing error, a typo — open an issue and someone will look.