Skip to content
Agim

Install im-hub

Three install paths, pick the one that fits. The interactive installer is the fastest for a fresh box; npm-global suits hands-on operators; source build is for contributors.

1 1 · Interactive installer (recommended)

A bash script with three prompts — language, ACP port, and web port. It installs `agim-cli` from npm (the binary is `agim`), writes a minimal `~/.agim/config.json` (or keeps `~/.im-hub/` on upgrades), drops a systemd unit if run as root, then launches `agim config` so you can pick messengers, agents, SMTP, Baidu Maps AK, etc. Re-runnable; safe to abort at any prompt.


            bash -c "$(curl -fsSL https://imhub.iclaw.host/install.sh)"
          

systemd unit installed automatically when run as root. Otherwise foreground via `agim start`.

Requires curl, bash, npm, and Node.js ≥ 22. Run as the user that will own ~/.im-hub.

2 2 · npm global

Install the binary globally; bring your own config file. See the README for the schema.

npm install -g agim-cli

3 3 · From source

Clone, install deps, build, and run. Useful when you want to patch the agent surface or add a new messenger.

git clone https://github.com/benking007/imhub.git
cd imhub
npm install
npm run build
sudo systemctl daemon-reload && sudo systemctl restart agim.service

Next steps

After install, send /help in your messenger to confirm the bot is online. /agents lists registered agents; /status shows connectivity. The full command reference is in the README.