Skip to main content

​
Listing agents

To list all agents, run the following command: Use the orchestrate agents list command to list all agents in your environment. You can also use the --verbose (-v) flag to get detailed information about each agent in JSON format.
BASH
orchestrate agents list -v

​
Exporting agents

Use the orchestrate agents export command to export an agent configuration from your active environment. You can export the full agent configuration with all its dependencies (default), or only the agent configuration by including the --agent-only flag.
BASH
orchestrate agents export -n <agent-name> -k <agent-type> -o <output-path>.zip
Note: Agentic workflow tools are only exported when you use a local environment with watsonx Orchestrate Developer Edition.

​
Updating agents

To update an agent, run the import command again using the same agent name as the agent you want to update.
BASH
orchestrate agents import -f <path to agent file that you want to update>

​
Removing agent

To remove an existing agent, run the following command:
BASH
orchestrate agents remove --name my-agent --kind native

​
Chatting with an agent in interactive mode through the CLI

To start a chat session with an agent, run the following command:
BASH
orchestrate chat ask --agent-name <agent_name>
To start a chat session and ask an initial question, run the following command:
BASH
orchestrate chat ask --agent-name <agent_name> "What is the weather?"
To start a chat session and view the agent’s reasoning trace, run the following command:
BASH
orchestrate chat ask --agent-name <agent_name> "What is the weather?" --include-reasoning