Quick start
From zero
to the first answer
Fifteen minutes on a Linux machine. At the end you have a working agent, one connected connector and an open chat page.
Before you begin
What you need to have
- Linux. The main platform, everything was verified on it. Windows and the rest are on the install page.
- Go 1.26 or newer. Needed only to build the binary.
- Python 3.12 or newer. Connectors run on the standard library, no packages to install.
- A model key. MiMo, any OpenAI-compatible API, YandexGPT or GigaChat.
- Access to at least one system. A Bitrix24 webhook or a Direct token is enough for the first run.
max_tokens: anything lower truncates the answer mid-sentence.Steps
Three steps to a conversation
Build
Clone the repository and build the binary. make build puts it in bin/interclaw, with no dependencies to pull.
Configure
interclaw setup asks for the model provider, the key and a channel. Everything is written to an environment file with mode 600, not into process arguments.
Run
interclaw serve brings up local HTTP on 127.0.0.1 and starts the configured channels. The chat page opens at the same address.
Commands
The same thing as a script
# 1. build$ git clone https://github.com/nobi-k/interclaw && cd interclaw$ make build # 2. configure the model and a channel$ ./bin/interclaw setupmodel provider: mimo | openai | yandexgpt | gigachatchannel: telegram | discord | bitrix24 | web only # 3. check the connector before starting$ ./bin/interclaw connector tools -- python3 connectors/bitrix24/server.pycrm_discover_portal, crm_fields, crm_list, crm_smart_process, ... # 4. run$ ./bin/interclaw servelistening on 127.0.0.1:8790, telegram channel alive
Step 3 stands on its own for a reason: a connector that does not answer tools/list will not work inside the agent either. Checking it with one command is cheaper than hunting for the cause in the service journal.
First conversation
What to ask to see the point immediately
A good first question is not «hello» but reconnaissance. The agent shows what it can learn about your account, and it becomes visible where data is missing.
- «What is configured in my Bitrix: which pipelines, stages and required fields?»
- «How many requests arrived last week and from which sources?»
- «Compare how many deals the portal declared against how many it actually returned.»
- «Every Monday at 9:00 send me the same thing in Telegram.»
interclaw schedule list: a job the agent confirmed in words but never wrote down looks identical to a recorded one - until Monday.Next
Where to go after the first answer
- Run it as a service so the schedule works without an open terminal:
docs/личная-обкатка.md. - Connect the remaining systems: the connector catalogue in
docs/connectors/README.md. - Restrict the dangerous parts: the list of tools requiring confirmation and of sites allowed for browser actions,
docs/безопасность.md. - Add your own skill: the
SKILL.mdformat and the plugin manifest are described on the skills page.
If it did not go
Common snags
The channel started but the bot is silent
Telegram will not connect from Russia
The connector starts but shows zero tools
The model truncates the answer mid-sentence
max_tokens. MiMo has a floor of 8192, below which the answer is cut. A tool result is separately capped at a fraction of the model window, and the truncation is marked explicitly so the model does not invent the remainder.The service shows as active but nothing is happening
Did it work?
Tell us what you want to automate next. Or look at what changed in the recent releases.