Terminal
Terminal/Skill
Guides the algobot CLI for creating, configuring, and deploying Algolia Agent Studio AI agents across environments.
By Algolia
Works with
npx skills add algolia/skills --skill algobot-cliAlgolia Agent Studio is Algolia's platform for building AI agents — RAG systems, conversational experiences, genAI content generation — with Algolia search and recommendations as the retrieval backbone. algobot (npm install -g algobot-ai) is its CLI for creating, testing, and deploying agents.
| Need | Use |
|---|---|
| Build/manage AI agents on Algolia (RAG, chatbot, genAI UI) | algobot-cli (this skill) |
| Algolia search index ops (records, settings, synonyms) | algolia-cli |
| Search queries, analytics, recommendations | algolia-mcp |
npm install -g algobot-ai
algobot init # Interactive wizard (creates first agent + profile)
Or add a profile manually (CI-safe, non-interactive):
algobot profiles add --name prod --env prod
The TUI won't render in non-TTY environments (CI, scripts, agent subprocesses). Use these instead:
algobot ask "What is your return policy?" # One-shot
algobot interactive --text "hello ||| list my orders ||| /context" # Multi-turn
algobot agents list --jq '.[] | .name' # JSON filtering
--jq is built-in — no need to install jq separately.
algobot agents list
algobot agents get <agent-id>
algobot agents create --name "Support Bot" --model gpt-4o
algobot agents update <agent-id> --name "New Name"
algobot agents publish <agent-id>
algobot agents unpublish <agent-id>
algobot agents delete <agent-id>
algobot agents copy <id> --from-env dev --to-env prod
algobot ask "Find wireless headphones under $100"
algobot --profile staging ask "hello" # Target specific environment
algobot --verbose ask "debug this" # Show full HTTP traces
algobot profiles list
algobot profiles add --name dev --env dev
algobot profiles setdefault prod
algobot --profile prod agents list
algobot --env dev agents list
Version-control agent definitions with mustache templates — ideal for repeatable deployments across events, teams, or environments.
# 1. Scaffold from an existing agent
algobot agents scaffold <agent-id> # → agent-config.json + PROMPT.md
# 2. Preview (API-level kill switch — mutations blocked by construction)
algobot --dry-run agents create --config agent-config.json --var event="Spring 2026"
# 3. Deploy
algobot agents create --config agent-config.json --var event_name="Spring 2026"
# 4. Update + publish in one step
algobot agents update <id> --config agent-config.json --var event_name="Summer 2026" --publish
{{key}} in JSON fields: JSON-safe escaping. In .md instructions: raw substitution.
Beyond basic chat, Agent Studio agents support:
algobot tools list/add/removealgolia_memorize, algolia_ponder, and algolia_memory_search tools. Configure retrieval mode (preload vs preflight) in agent config.algobot conversations for export/delete[1][2] on responses, date injection, response caching — enable in agent configUse algobot agents scaffold to inspect/edit these settings, algobot --dry-run to preview before applying.
algobot agents watch patch.json # Auto-apply patches on file change
| Flag | Effect |
|---|---|
--env dev|staging|prod|local | Target environment |
--profile <name> | Use named profile |
--dry-run | Preview without mutating (API-enforced) |
--verbose | Full HTTP logs |
--jq '<expr>' | Filter JSON output |
--confirm | Skip exec tool confirmations |
algobot with no args launches the TUI — hangs in scripts. Always use ask or --text in non-interactive contexts.--output json missing on most commands in v2.0. Use --jq or JSON-structured stdout.algobot init is interactive. Don't use in CI — use profiles add with flags instead.prod resolves to the EU host. v2.0.0 hardcodes three API hosts — agent-studio.eu.algolia.com (prod), agent-studio-staging.eu.algolia.com (staging), conversational-ai-dev.algolia.com (dev). There is no region flag, and the only environment variables read are ALGOLIA_APP_ID, ALGOLIA_APPLICATION_ID, ALGOLIA_API_KEY, and ALGOLIA_AGENT_ID — none of which override the host. If an app's agents are not in EU, agents list returns [] and agents get <id> returns 404 for an agent that is live and serving completions. An admin API key does not change this. Confirm the host with algobot --verbose agents list before assuming a credential problem.~/.algobot-profiles (encrypted), not ~/.algobot-cookie. algobot auth show was removed in v2.0 — use algobot profiles list, or algobot profiles show <name> for full detail. Note that profiles show prints the API key in plaintext, so avoid it in shared terminals, screenshares, and logs.--config auto-discovers agent-config.json in cwd. Explicit: --config path/to/config.json.algobot agents get <id> to retrieve it, or check the Agent Studio dashboard./agent-studio prefix. Use agent-studio.<region>.algolia.com/1/agents/<id>/completions?stream=false&compatibilityMode=ai-sdk-4. compatibilityMode is required (omitting → 422). Response: { id, role, content } with content as a flat string.agents create --provider <name> does not link the provider. Agent stays draft, publish 409s. After create, run algobot agents patch <id> --json patch.json with {"providerId": "<uuid>"}, then publish.