Quickstart

Quickstart#

Installation#

We recommend you to create a new virtual environment for the terminal agent.

uv venv autopilot --python 3.11
source autopilot/bin/activate

Then you can install autopilot in your virtual environment.

# Git clone this repo
git lfs install  # make sure this succeeds, otherwise you may need to install lfs first.
git clone git@github.com:Sailor-Agents/Terminal-Agents.git --recurse-submodules

# Install the autopilot package
cd Terminal-Agents

# if you are a user, you can install the package as a normal user.
uv pip install -v .

# if you are a developer, you can install the package in development mode
uv pip install -v -e .[dev]

Run the Agent#

Before running the agent, you need to initialize the config. You need to edit this config file to set up the LLM key and optional remote telemetry storage. The init configuration is only a reference configuration, you can modify it according to your needs.

# initialize the config
autopilot config init

# edit the config
autopilot config edit

Next, you can run the agent in terminal mode.

# run the agent
autopilot run --terminal

# if you want to disable telemetry
autopilot run --terminal --no-log-to-mongodb --no-log-to-github

For more details about the CLI, you can refer to the CLI Design page.

You can try the example tasks below to have a try with the terminal agent.

  1. Show me the the weather of Singpore right now by API.

  2. Calculate the average stock price of SEA over the last three months by calling the Finance API.

Contents