Skip to content

Install And Run

This guide shows how to run AgentTrace on your computer.

Requirements

You need:

  • Python 3.10 or newer
  • Git
  • a project that is already a Git repository

To check Python:

python --version

To check Git:

git --version

Install From This Project Folder

Open PowerShell in the AgentTrace project folder.

Use the folder where you cloned or downloaded AgentTrace. For example:

cd path\to\agenttrace

Install AgentTrace for development:

python -m pip install -e .

After that, this command should work:

agenttrace --help

Run Without Installing

If you do not want to install it yet, you can run it like this from the project folder:

$env:PYTHONPATH='src'
python -m agenttrace --help

When using this method, replace agenttrace with python -m agenttrace in the examples.

For example:

python -m agenttrace init

Run The Project Tests

From the AgentTrace project folder:

$env:PYTHONPATH='src'
python -m unittest discover -s tests

If everything is working, you should see output ending with:

OK