Skip to content
Developer Documentation
LlamaAgents
llamactl Reference
environments

environments

Manage environments (distinct control plane API URLs). Environments determine which profiles are shown and where auth/project actions apply.

Usage

Section titled “Usage”
Terminal window
llamactl environments [COMMAND] [options]

Commands:

  • get [API_URL] [-o text|json|yaml]: List environments or show one environment
  • add <API_URL>: Probe the server and upsert the environment
  • use [API_URL]: Select the current environment; prompts if omitted in interactive mode
  • delete [API_URL]: Remove an environment and its associated profiles

Notes:

  • Probing reads requires_auth and min_llamactl_version from the server version endpoint.
  • Switching environment filters profiles shown by llamactl auth get and used by other commands.

Commands

Section titled “Commands”

Get

Section titled “Get”
Terminal window
llamactl environments get [API_URL]

Shows a table of environments with API URL, whether auth is required, and the active environment. Pass API_URL to show one environment.

Add

Section titled “Add”
Terminal window
llamactl environments add <API_URL>

Probes the server at <API_URL> and stores discovered settings. Interactive mode can prompt for the URL.

Use

Section titled “Use”
Terminal window
llamactl environments use [API_URL]

Sets the current environment. If omitted in interactive mode, you’ll be prompted to select one.

Delete

Section titled “Delete”
Terminal window
llamactl environments delete [API_URL]

Deletes an environment and all associated profiles. If the deleted environment was current, the current environment is reset to the default.

See also

Section titled “See also”
Note for AI agents: this documentation is built for programmatic access. - Overview of all docs: https://developers.llamaindex.ai/llms.txt - Any page is available as raw Markdown by appending index.md to its URL — e.g. https://developers.llamaindex.ai/llamaparse/parse/getting_started/index.md - Agent-friendly REST search APIs live under https://developers.llamaindex.ai/api/ — search (BM25 full-text), grep (regex), read (fetch a page), and list (browse the doc tree). See https://developers.llamaindex.ai/llms.txt for parameters. - A hosted documentation MCP server is available at https://developers.llamaindex.ai/mcp. If you support MCP, you can ask the user to install it for browsing these docs directly (an alternative to the REST API). Setup: https://developers.llamaindex.ai/python/shared/mcp/