Quickstart — Smooth Agent
Install the open-source Smooth Agent on Linux or macOS, connect a model and talk to it from Telegram, in about five minutes.
You need Python 3.9 or newer and an API key for any model provider (OpenAI, DeepSeek, GLM, Groq, OpenRouter, Kimi, a local server, or Smooth's own API).
Install
bashcurl -fsSL https://raw.githubusercontent.com/smooth-family/smooth-agent/main/install.sh | bashThe installer checks your machine, installs with
pipx(or a private virtualenv in~/.smooth-agent/venv), putssmooth-agenton your PATH and starts the setup wizard. Nothing is installed system-wide. Prefer Docker? See Install.Run the setup wizard
bashsmooth-agent setupPick a provider and model, paste your key (it goes into
~/.smooth-agent/.env, mode 600) and choose your chat channels.Check and talk
bashsmooth-agent doctor --ping # what works on this machine, and a test call to the model smooth-agent run # talk to it in the terminalConnect Telegram and keep it running
Create a bot with @BotFather, put the token in
.envasTELEGRAM_BOT_TOKEN, message your bot once to get your numeric id, then:bashsmooth-agent daemon # chat channels + scheduled jobs smooth-agent service --install # or run it as a background service
Where things live
Everything is in ~/.smooth-agent/ (change it with SMOOTH_AGENT_HOME):
| Path | What it holds |
|---|---|
config.toml | Providers, models and settings |
.env | API keys and bot tokens (mode 600) |
workspace/ | The agent's working folder and its persona files |
skills/ | Skills you installed or the agent wrote |
mcp.json | MCP servers |
smooth.db | Memory, conversations and scheduled jobs |
Next steps
Last updated: