Skip to main content
Unlisted page
This page is unlisted. Search engines will not index it, and only users having a direct link can access it.

Example: Chariot CLI

The Chariot CLI (Command Line Interface) is the primary tool for building, managing, and running agentic workflows in Chariot. It is distributed as part of the Chariot SDK and runs as a terminal application.

This walk-through demonstrates how to quickly create and chat with a simple agentic workflow using the Chariot CLI. You can extend this example to explore more advanced configurations as you become familiar with the system.

Prerequisites​

Before you begin, ensure that you have:

1. Launch the Chariot CLI​

Open a terminal. Go to the same Python environment where you installed the Chariot SDK. Start the agentic workflows CLI by running:

chariot awm

This launches the Chariot CLI menu interface. Use your arrow keys and Enter to navigate.

2. Select a Chariot Project​

Upon startup, you'll be prompted to select a Chariot project. If you don't already have a project, log in and create one via the web portal. Projects that you are a member of will appear in this list.

Select your desired project (e.g., My Example Project).

Chariot CLI project selection

note

Projects cannot be created directly within the CLI workflow menus.

3. Create Your First Workflow​

You will now see the Workflows menu for your selected project, where you can view existing workflows or create a new one.

Chariot CLI Workflows menu

  • Choose Create workflow.
  • Enter a name and a description for your workflow (e.g., My Test Workflow).

After providing these details, you'll be presented with the workflow configuration in a Vim editor. A default configuration is supplied, which defines a simple orchestrator agent (see Agents).

Default workflow configuration in Vim

To accept the default configuration, type :q! and press Enter to exit the editor without changes.

Default Workflow Configuration​

The default configuration sets up:

  • A single orchestrator agent (e.g., Agent007), with a simple system prompt ("Talk in the voice of James Bond").
  • No external tool integrations or advanced options.

This will serve as our demonstration workflow.

4. Start and Test Your Workflow​

Once you exit the editor, your workflow will be created. Select List workflows to verify, and open your new workflow's menu.

  • By default, workflows are paused upon creation. Select Resume to activate your workflow. This action provisions your workflow and sets its state to running.

Next, select Chat. Since no previous sessions exist, choose New session to start your first chat.

You will now see the CLI chat interface. Type a greeting, such as "Hello", and observe the agent's reply. The orchestrator agent will respond according to its defined system prompt, as no other agents or tools are configured at this stage.

Chariot CLI session chat interface

CLI Chat Features​

Within the chat interface, you can:

  • Create and switch between sessions
  • View session chat history
  • Exit to the main menu using slash commands

For example, type /exit to leave the chat and return to the Workflows menu.