pbi-cli/README.md
MinaSaad1 49c38dbb74 fix: make README render correctly on PyPI
Use absolute GitHub URL for SVG header and replace Mermaid diagrams
with plain text art since PyPI does not support either.
2026-03-26 16:53:39 +02:00

9.7 KiB

pbi-cli

Give Claude Code the Power BI skills it needs. Install once, then just ask Claude to work with your semantic models.

PyPI Python CI License

Get StartedSkillsAll CommandsREPL ModeContributing


What is this?

pbi-cli gives Claude Code (and other AI agents) the ability to manage Power BI semantic models. It ships with 5 skills that Claude discovers automatically. You ask in plain English, Claude uses the right pbi commands.

You                        Claude Code              pbi-cli              Power BI
 "Add a YTD measure   --->  Uses Power BI    --->   CLI commands   --->  Desktop / Fabric
  to the Sales table"       skills

Get Started

Fastest way: Just give Claude the repo URL and let it handle everything:

Install and set up pbi-cli from https://github.com/MinaSaad1/pbi-cli.git

Or install manually (two commands):

pipx install pbi-cli-tool    # 1. Install (handles PATH automatically)
pbi connect                  # 2. Auto-detects Power BI Desktop, downloads binary, installs skills

That's it. Open Power BI Desktop with a .pbix file, run pbi connect, and everything is set up automatically. Open Claude Code and start asking.

You can also specify the port manually: pbi connect -d localhost:54321

Requires: Python 3.10+ and Power BI Desktop (local) or a Fabric workspace (cloud).

Using pip instead of pipx?
pip install pbi-cli-tool

On Windows, pip install often places the pbi command in a directory that isn't on your PATH.

Fix: Add the Scripts directory to PATH

Find the directory:

python -c "import site; print(site.getusersitepackages().replace('site-packages','Scripts'))"

Add the printed path to your system PATH:

setx PATH "%PATH%;C:\Users\YourName\AppData\Roaming\Python\PythonXXX\Scripts"

Then restart your terminal. We recommend pipx instead to avoid this entirely.


Skills

After running pbi skills install, Claude Code discovers 5 Power BI skills. Each skill teaches Claude a different area of Power BI development. You don't need to memorize commands. Just describe what you want.

You: "Set up RLS for regional managers"
  |
  v
Claude Code --> Picks the right skill
                  |
                  +-- Modeling
                  +-- DAX
                  +-- Deployment
                  +-- Security
                  +-- Documentation

Modeling

"Create a star schema with Sales, Products, and Calendar tables"

Claude creates the tables, sets up relationships, marks the date table, and adds formatted measures. Covers tables, columns, measures, relationships, hierarchies, and calculation groups.

Example: what Claude runs behind the scenes
pbi table create Sales --mode Import
pbi table create Products --mode Import
pbi table create Calendar --mode Import
pbi relationship create --from-table Sales --from-column ProductKey --to-table Products --to-column ProductKey
pbi relationship create --from-table Sales --from-column DateKey --to-table Calendar --to-column DateKey
pbi table mark-date Calendar --date-column Date
pbi measure create "Total Revenue" -e "SUM(Sales[Revenue])" -t Sales --format-string "$#,##0"

DAX

"What are the top 10 products by revenue this year?"

Claude writes and executes DAX queries, validates syntax, and creates measures with time intelligence patterns like YTD, previous year, and rolling averages.

Example: what Claude runs behind the scenes
pbi dax execute "
EVALUATE
TOPN(
    10,
    ADDCOLUMNS(VALUES(Products[Name]), \"Revenue\", CALCULATE(SUM(Sales[Amount]))),
    [Revenue], DESC
)
"

Deployment

"Export the model to Git and deploy it to the Staging workspace"

Claude exports your model as TMDL files for version control, then imports them into another environment. Handles transactions for safe multi-step changes.

Example: what Claude runs behind the scenes
pbi database export-tmdl ./model/
# ... you commit to git ...
pbi connect-fabric --workspace "Staging" --model "Sales Model"
pbi database import-tmdl ./model/
pbi model refresh --type Full

Security

"Set up row-level security so regional managers only see their region"

Claude creates RLS roles with descriptions, sets up perspectives for different user groups, and exports role definitions for version control.

Example: what Claude runs behind the scenes
pbi security-role create "Regional Manager" --description "Users see only their region's data"
pbi perspective create "Executive Dashboard"
pbi perspective create "Regional Detail"
pbi security-role export-tmdl "Regional Manager"

Documentation

"Document everything in this model"

Claude catalogs every table, measure, column, and relationship. Generates data dictionaries, measure inventories, and can export the full model as TMDL for human-readable reference.

Example: what Claude runs behind the scenes
pbi --json model get
pbi --json model stats
pbi --json table list
pbi --json measure list
pbi --json relationship list
pbi database export-tmdl ./model-docs/

All Commands

22 command groups covering every Power BI MCP server operation. You rarely need these directly when using Claude Code, but they're available for scripting, CI/CD, or manual use.

Category Commands
Queries dax execute, dax validate, dax clear-cache
Model table, column, measure, relationship, hierarchy, calc-group
Deploy database export-tmdl, database import-tmdl, database export-tmsl, model refresh, transaction
Security security-role, perspective
Connect connect, connect-fabric, disconnect, connections list
Other partition, expression, calendar, trace, advanced, model get, model stats
Tools setup, repl, skills install, skills list

Use --json for machine-readable output (for scripts and AI agents):

pbi --json measure list
pbi --json dax execute "EVALUATE Sales"

Run pbi <command> --help for full options.


REPL Mode

For interactive work, the REPL keeps the MCP server running between commands (skipping the ~2-3s startup each time):

$ pbi repl

pbi> connect --data-source localhost:54321
Connected: localhost-54321

pbi(localhost-54321)> measure list
pbi(localhost-54321)> dax execute "EVALUATE TOPN(5, Sales)"
pbi(localhost-54321)> exit

Tab completion, command history, and a dynamic prompt showing your active connection.


How It Works

pbi-cli wraps Microsoft's official Power BI MCP server binary behind a CLI. The binary is downloaded automatically by pbi setup from the VS Code Marketplace.

+------------------+         +----------------------+         +------------------+
|     pbi-cli      |         |  Power BI MCP Server |         |    Power BI      |
|  CLI commands -->-| stdio  |    (.NET binary)     |  XMLA   |  Desktop/Fabric  |
|  MCP client      |-------->|                      |-------->|                  |
+------------------+         +----------------------+         +------------------+

Why a CLI wrapper? When an AI agent uses an MCP server directly, the tool schemas consume ~4,000+ tokens per tool in the context window. A pbi command costs ~30 tokens. Same capabilities, 100x less context.

Configuration details

All config lives in ~/.pbi-cli/:

~/.pbi-cli/
  config.json          # Binary version, path, args
  connections.json     # Named connections
  repl_history         # REPL command history
  bin/{version}/       # MCP server binary

Binary resolution order:

  1. $PBI_MCP_BINARY env var (explicit override)
  2. ~/.pbi-cli/bin/ (managed by pbi setup)
  3. VS Code extension fallback

Development

git clone https://github.com/MinaSaad1/pbi-cli.git
cd pbi-cli
pip install -e ".[dev]"
ruff check src/ tests/         # Lint
mypy src/                      # Type check
pytest -m "not e2e"            # Run 120 tests

Contributing

Contributions are welcome! Please open an issue first to discuss what you'd like to change.

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes with tests
  4. Open a pull request

GitHub PyPI

MIT License