Any OpenAI-compatible endpoint
Local model — no API key needed.
~/aidog/web/settings.json
Self-hosted personal AI companion — talks to you on Telegram, Feishu and DingTalk, managed from a local web console
AiDog · icon from the registry
This app ships with everything it needs — no Node.js, Python or other runtimes to install.
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 file written to
~/aidog/web/settings.json
Everything stays on your own machine — nothing is uploaded. To uninstall, delete these folders.
One portable file for Windows (macOS coming). Double-click and it runs — no installer, no administrator rights.
Go to download →Open the AiBOX app catalog, find AiDog and press Install. AiBOX checks what your machine already has and installs only what is missing.
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 ↓
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.
/cron), memory evolution (/learn, /reflect)| Need | Notes |
|---|---|
| Windows | Requires WSL2 (e.g. Ubuntu). The AiDog runtime officially lives inside WSL; the native Windows shell is attach-only |
| macOS | Upstream 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 |
| tmux | Needs administrator rights: run sudo apt-get install tmux inside WSL yourself — AiBOX never escalates privileges for you |
| Model endpoint | Any 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 mountedC:\drive — 9p/CIFS mounts rejectchmodand break tmux; copying a Windows-side clone in also breaks the.shscripts with CRLF line endings.
~/aidog inside WSL and runs the official one-command installer deploy/install.sh (provision + boot + verify; safe to re-run)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
aidog setup only prompts for slots that are still empty (hidden input, values are never echoed):
WEB_TOKEN: a console write token — any long random string you inventbase_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)aidog setup --check exits 0 (fully ready) or 2 (only credentials pending) — never 1/help from an allowlisted Telegram account and get a replypython3 ~/aidog/deploy/aidog_doctor.py: zero FAILstmux not found: install tmux manually (admin required, see above), then re-run bash deploy/install.shport 19167 is used: boot on another port: AIDOG_WEB_PORT=19200 bash deploy/boot_services.sh startmycore.base_url in web/settings.json responds; exit code 2 with nothing configured is an honest "not configured yet", not a crashHTTPS_PROXY); set it in the shell that starts the tmux sessionsaidog update apply refuses with a dirty tree: by design — commit local changes before upgradingbash ~/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
AiBOX fills this in for you during the wizard — this section is for setting it up by hand.
Local model — no API key needed.
~/aidog/web/settings.json
Runs on Windows / macOS — install it with AiBOX on any of them.
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.
Everything stays on your own machine: ~/aidog. To uninstall, delete these — nothing is ever uploaded.
An outdated step, an error you do not understand, a typo — tell us and we will fix this page.
Upstream projects
Version numbers are re-checked by our daily probe — when upstream ships a new release, this page follows.
A wrong step, a confusing error, a typo — open an issue and someone will look.