How to Use Agent

To pipeline of how to use agents in AIOS is shown as the following figure.

AIOS Agent Integration Flow

AIOS first checks cache for the agent (typically the source code of the agent will be stored in ~/.cache/cerebrum/) and then installs the agent if it is not available.

Running Agents

Run a Remote Agent

Use this command to run an agent from the AIOS Agent Hub:

run-agent \
  --mode remote \
  --agent_author example \
  --agent_name test_agent \
  --agent_version 0.0.3 \
  --task "What is the capital of United States?" \
  --agenthub_url https://app.aios.foundation

Run a Local Agent

For agents already available on your local device:

run-agent \
  --mode local \
  --agent_path cerebrum/example/agents/test_agent \
  --task "What is the capital of United States?"

Agent Management

View agents available in the AIOS Agent Hub:

list-agenthub-agents

View agents available locally:

list-local-agents

Download an agent from the AIOS Agent Hub:

download-agent \
  --agent_author <agent_author> \
  --agent_name <agent_name> \
  --agent_version <agent_version> \
  --agenthub_url <agenthub_url>

Upload an agent to the AIOS Agent Hub:

upload-agents \
  --agent_path <agent_path> \
  --agenthub_url <agenthub_url>