The official CLI for Elmo — open source AI visibility tracking and optimization.
Read the docs »
What is Elmo?
Elmo is an open source platform for tracking and optimizing how your brand shows up in AI assistants like ChatGPT, Claude, Gemini, and Perplexity. Define the prompts your customers ask, run them across providers on a schedule, and get visibility into mentions, sentiment, citations, and competitor positioning over time.
@elmohq/cli is the fastest way to run Elmo on your own infrastructure. It generates a Docker Compose stack, manages secrets and configuration, and gives you a single command to start, stop, and operate your instance.
Installation
npm install -g @elmohq/cli
Requires Docker and Docker Compose.
Quick Start
# 1. Walk through the interactive setup wizard
elmo init
# 2. Start the stack
elmo compose up -d
# 3. Open the app at http://localhost:1515
elmo init will prompt you for a few things (database, AI provider credentials), generate elmo.yaml and .env, and optionally start the stack for you.
For the full self-hosting walkthrough, see the Elmo docs.
Commands
| Command | Description |
|---|---|
elmo init | Interactive wizard to set up a local Elmo instance |
elmo compose <args...> | Run any docker compose command against your Elmo project (e.g. elmo compose up -d, elmo compose down, elmo compose logs -f, elmo compose build, elmo compose ps) |
elmo edit <env|compose> | Change API keys, scrape targets, or the Docker Compose YAML |
elmo upgrade | Move your deployment to this CLI's version — runs migrations, re-pins image tags, and restarts the stack |
Run elmo --help or elmo <command> --help for the full list of flags.
Useful flags
--dir <path>— point any command at a specific config directory (defaults to~/.elmo).elmo init --dev— build images from a local checkout of the repo instead of pulling from the registry.
Telemetry
The CLI sends anonymous install and command events so we can understand which flows people use and where setup breaks. To opt out, either export DISABLE_TELEMETRY=1 in your shell, or add it to your .env:
elmo edit env # add DISABLE_TELEMETRY=1
elmo compose up -d # restart so the deployment picks it up
See the telemetry docs for details on what is collected.
Star, contribute, and chat
Elmo is built in the open and we'd love your help.
- ⭐ Star us on GitHub — it genuinely helps more people find the project.
- 💬 Join the Discord — get help, share what you're building, and talk to the team.
- 🐛 File an issue if something breaks or you have a feature request.