Useful CLI commands

Checking the ADK version

To check the currently installed version of the ADK, use the --version flag.

Example

BASH

orchestrate --version

Getting help with commands

Use the --help flag to get more information about a command and its available flags.

To use it, simply add —help after the command you want to learn more about.

Example

Example 1

BASH

orchestrate --help

Example 2

BASH

orchestrate env --help

Example 3

BASH

orchestrate agents --help

Example 4

BASH

orchestrate agents import --help

Running commands in debug mode

If you want more detailed output when running a command, use the --debug flag. This runs the command in debug mode and provides additional diagnostic information.

Add —debug before the command you want to run.

Example

Example 1

BASH

orchestrate --debug env activate local

Example 2

BASH

orchestrate --debug agents import -f agent.yaml

Example 3

BASH

orchestrate --debug tools import -k python -f tool.py

Settings

ADK opens many files—such as Python, JSON, and YAML—to build agents, tools, knowledge bases, and more. You can override the encoding method ADK uses to decode files when automatic detection fails.

Note:

You don’t need to configure the encoding type to use ADK. The following commands are optional and help handle specific edge cases.

Setting an encoding Type

Set the encoding type ADK uses for file access. If unset, ADK tries to detect the encoding of each file.

To set the encoding type, use the command:

BASH

orchestrate settings set-encoding <encoding-type>

Setting encoding to default

Unset the encoding override and return to the default behavior, where ADK tries to detect the encoding of each file.

To set the encoding type to default, use the command:

BASH

orchestrate settings unset-encoding