cloteragent
v0.1.6
Published
Self-hosted AI agents with memory, tools, and chat gateways (CLI, Telegram, Discord, Slack, WhatsApp, Signal, Matrix, LINE, Mattermost, Zulip).
Downloads
708
Maintainers
Readme
CloterAgent
Your own AI assistants that remember you. They run on your computer, keep conversations and facts over time, and can talk to you in the terminal or in apps like Telegram and Discord—using the AI provider you choose.
This package’s home on GitHub is github.com/wassi-real/cloteragent—that is where the source and project updates live.
What you need
- Node.js version 18 or newer installed on your computer.
- An API key from an AI service you use (for example OpenRouter, OpenAI, or a free local setup with Ollama on your machine). You will paste this during setup.
Install
Open a terminal (Command Prompt, PowerShell, or Terminal on Mac/Linux) and run:
npm install -g cloteragentThen check that it worked:
cloter --helpIf the install fails, make sure Node.js is installed and try again. On some Windows or Linux setups you may need to run the terminal as administrator or use a “sudo” install step—follow what your system asks for.
First-time setup
Connect your AI provider and optionally your chat apps:
cloter config setupThis asks a few questions and saves everything to a file on your computer (in your user folder under .cloter). You do not need to create or edit config files by hand.
Same wizard, different command name:
cloter onboardingTo see what is saved (passwords are hidden):
cloter config listIf something looks wrong, run:
cloter doctorUse it day to day
1. Create an assistant (pick any short name, letters and numbers):
cloter create my-assistant2. Chat in the terminal:
cloter chat my-assistantType your messages normally. Commands like /exit or /help work inside the chat (see what the program prints when you start it).
Your assistant remembers the next time you open chat, because data is stored on your machine.
Chat apps (optional)
After you add the right tokens in cloter config setup (or with cloter config set…), you can run your assistant on a messenger. Replace my-assistant with the name you created.
| App | Start command |
|-----|----------------|
| Telegram | cloter connect telegram my-assistant |
| Discord | cloter connect discord my-assistant |
| Slack | cloter connect slack my-assistant |
| Others (WhatsApp, Signal, Matrix, LINE, Mattermost, Zulip) | Same pattern: cloter connect <app> my-assistant |
cloter connect starts the messenger in the background, so your terminal is free for other commands right away.
- Several messengers for one agent: run
cloter connect telegram …, thencloter connect discord …, and so on (each uses the saved token for that app). - Several agents at once: run
cloter connect telegram agent-aandcloter connect telegram agent-b. If both use Telegram, each one needs its own bot token — use--telegram-tokenon the command (or different global settings are not possible for two bots at once without overrides). - Same agent, two Telegram bots (two channels / two bots) give the second one a name with
--tag shopand--telegram-token …for that bot’s token. Stop withcloter gateway stop my-assistant telegram --tag shop.
To check or stop background messengers:
cloter gateway status
cloter gateway stop my-assistant telegram
cloter gateway stop my-assistant telegram --tag shopTo run several apps at once for the same assistant (only the ones you already configured):
cloter gateway start my-assistantEach platform has its own signup steps (bot tokens from Telegram’s BotFather, Discord Developer Portal, and so on). The setup wizard explains what to paste; you can also run cloter config with no arguments to see reminders.
Useful commands
| What you want | Command |
|----------------|---------|
| Change API keys or tokens later | cloter config setup again, or cloter config set ... (run cloter config --help) |
| List your assistants | cloter list |
| Allow running shell commands in chat (advanced) | cloter chat my-assistant --allow-shell |
| See running messengers | cloter gateway status |
| Stop a messenger | cloter gateway stop my-assistant telegram (add --tag … if you used --tag when connecting) |
| See what’s configured | cloter doctor |
Where your data lives
Everything is on your computer, under a folder called .cloter in your home directory:
- Settings (API keys you saved): one file in that folder
- Each assistant: its own subfolder with chat history, memory, and saved “skills”
Nothing is sent to us—only to the AI and chat services you connect.
License
MIT.
