Installation

Prerequisites

Requirement	Notes
Python	>= 3.12
uv	Recommended for local development and running the CLI from source

WARNING

pbi-agent operates on PBIP projects, not .pbix files. If you are starting from Power BI Desktop, save the report as a Power BI Project first or bootstrap one with pbi-agent init.

Install from PyPI

uv tool install pbi-agent

WARNING

If this is your first uv tool install, reload your shell before running pbi-agent or the command may not be on your PATH yet.

To update an existing installation later, run:

uv tool upgrade pbi-agent

Install from Source

git clone https://github.com/nasirus/pbi-agent.git
cd pbi-agent
uv sync

Verify the Install

uv run pbi-agent --help

If you installed the package with uv tool install, you can also verify it with pbi-agent --help.

Quick Start

Set an API key, then run the browser UI or a single prompt:

export PBI_AGENT_API_KEY="sk-..."
uv run pbi-agent

uv run pbi-agent run --prompt "Describe the PBIP project structure in this workspace."

TIP

Startup loads environment variables from a local .env file automatically through python-dotenv, so you can keep PBI_AGENT_API_KEY, PBI_AGENT_PROVIDER, and related settings there.

First-time bootstrap

If you do not already have a PBIP workspace, create one in the current directory with uv run pbi-agent init --dest .. The init command does not require provider credentials because it only copies the bundled report template.