Generated banner for Powerbi Report CLI
Generated logo for Powerbi Report CLI

Powerbi Report CLI

MicrosoftOfficialPublished by Microsoft

  • Skill
  • Tool integration
  • Data and AI
  • MIT
  • Low risk

From the author

Plan, design, author, preview, publish, and manage Power BI reports across requirements, page design, local PBIR/PBIP edits, validation, screenshots, Fabric upload/download, and rebinding. Use for report lifecycle work; use semantic-model-authoring for model or DAX changes and fabriciq for data questions. Triggers: plan Power BI report, design report page, edit PBIR, preview PBIP, publish report, rebind report
— the description by Microsoft

AutoGineer summary

Written by AutoGineer from the skill’s own files, not by the author

The powerbi-report-cli skill provides a structured, mode-based framework for managing the entire Power BI report lifecycle. It acts as a dispatcher across four distinct phases: planning (requirements and scope), design (visual and layout strategy), authoring (local PBIR/PBIP file manipulation and validation), and management (Fabric item transport and rebinding). The skill enforces strict boundaries between these modes to ensure quality, requiring explicit approval for new reports and utilizing a dedicated CLI for metadata-driven validation and authoring tasks.

What it does

  • Guides users through report requirements, scope, and page planning.
  • Provides design contracts for visual archetypes, layouts, and branding.
  • Enables local editing, validation, and previewing of PBIR and PBIP files.
  • Handles report item transport to and from Microsoft Fabric.
  • Supports re-theming, conditional formatting, and visual configuration.
  • Enforces a mandatory approval gate for greenfield report development.

When to use it

  • When planning a new Power BI report from a semantic model.
  • When you need to define a professional design brief or layout strategy.
  • When editing local PBIR/PBIP files, including visuals, filters, and themes.
  • When validating report structure and formatting before deployment.
  • When publishing or managing report items within a Fabric workspace.

Advantages

  • Ensures consistent report quality through a structured, multi-mode workflow.
  • Prevents premature publishing by enforcing a mandatory approval barrier.
  • Uses a dedicated CLI to eliminate guesswork in PBIR schema and property editing.
  • Maintains clear separation between design intent and technical implementation.
  • Provides robust validation tools to catch errors before Fabric deployment.

Usage examples

“Create a new executive report from this semantic model.”
The agent enters planning mode, inspects the model, generates a report spec, and requests user approval before proceeding.
“Design an operational page and choose the right charts.”
The agent enters design mode, produces a design brief with page archetypes and chart recommendations.
“Add a KPI page to this PBIP, validate it, and take screenshots.”
The agent enters authoring mode, modifies the local PBIP files, runs validation, and captures screenshots for review.
“Publish this local PBIP to my Fabric workspace and rebind it.”
The agent enters management mode, performs the upload to Fabric, and completes the rebind operation.

Install

  1. Download the skill as a ZIP:

    https://autogineer.com/agent-skills/microsoft/powerbi-report-cli/download
  2. Unzip it into the cross-client skills folder of your project:

    mkdir -p .agents/skills && unzip powerbi-report-cli.zip -d .agents/skills

Documentation by Microsoft

Telemetry — MANDATORY. Every api.fabric.microsoft.com call must carry x-ms-fabric-skill: powerbi-report-cli (az rest: --headers "x-ms-fabric-skill=powerbi-report-cli"), including every LRO poll, fabric_lro and retry. Snippets omit it — add it anyway.

CRITICAL NOTES

  1. To find workspace details, including its ID, from a workspace name: list all workspaces, then use JMESPath filtering.

  2. To find item details, including its ID, from a workspace ID, item type, and item name: list all items of that type in that workspace, then use JMESPath filtering.

  3. Use powerbi-report-cli for the report artifact: requirements, design, PBIR/PBIP page and visual edits, preview, and publishing. Semantic model, measure, and DAX work belongs to a semantic-model skill. Natural-language questions about report data belong to fabriciq.

Power BI Reports - CLI Skill

This skill owns the Power BI report lifecycle end to end: requirements and scope, visual design, local PBIR/PBIP authoring and preview, and report-item transport to and from Microsoft Fabric.

It is a mode dispatcher and intentionally contains no detailed procedures. Select the mode that matches the request, then read the matching mode reference end to end before acting. The mode file holds the required workflow, commands, payloads, templates, and failure rules.

Mode Selection

ModeUse when the request...Existing route examplesRead first
planningcreates a new report/dashboard and needs requirements, model/dependency inspection, scope, a page plan, and approval before implementationcreate a report, build a dashboard, create from a semantic model, plan then implement, walk me through creating a reportreferences/planning.md, then references/planning-part-02.md
designdecides what a report should look like: tone, signature, page archetype, chart type, layout, color, typography, theme direction, accessibility, brand application, redesign, or critiquedesign a Power BI report, make the dashboard professional, choose a chart, apply a brand, redesign the report, create a design briefreferences/design.md
authoringreads or edits local PBIR/PBIP files, validates them, previews the report, or captures screenshotsedit PBIR, create/add a report page or visual, format a visual, add filters/slicers/bookmarks/themes, validate PBIR, preview/reload/screenshot in Desktop or servicereferences/authoring.md
managementmoves a report definition to or from Fabric or manages the workspace report itempublish/upload/download PBIR or PBIP, list reports, get/update/delete a report, rebind a reportreferences/management.md

Mode Boundary Rules

  • Classify by intent, not by which file or tool is already open.

  • design decides what the report should look like; authoring writes the PBIR that realizes it. Choosing a chart type is design; encoding it into visual.json is authoring.

  • Restyling or reformatting an existing local report is authoring, even when the request uses design language. Use design when the user wants advice or a design contract rather than a file change.

  • authoring changes local files and performs preview/validation. It does not publish to Fabric.

  • management transports definitions and manages Fabric report items. It does not invent or directly author PBIR content.

  • planning owns the guided requirements-to-approval flow for a new report. A focused edit to an existing report goes directly to authoring.

A greenfield request can span modes in this order:

planning -> design -> authoring -> management

Handle one mode at a time. Announce each switch and read the new mode reference before starting that part. The planning approval gate is a turn boundary: never build or publish until the user explicitly approves the locked spec in a later reply.

GREENFIELD APPROVAL BARRIER — MANDATORY. When a new-report request asks to plan, build, and/or publish but the user has not approved a locked spec in a prior reply, set the current phase to approval_pending and keep planning as the only active mode. In this phase, do not load authoring or management, edit/scaffold PBIR or semantic-model files, generate synthetic data, call Fabric write APIs, or publish. Persist _brief/report-spec.md, ask for explicit approval, and end the turn. The build/publish wording in the original request is desired future scope, not approval to cross this barrier.

Required Deliverable by Mode

ModeCompletion requirement
planningPersist _brief/report-spec.md or the user-named equivalent, ask for explicit approval, and stop before implementation.
designProduce the complete Design Brief: contract, including design_identity and a page archetype/layout contract for every page. Do not edit PBIR or call Fabric APIs.
authoringPersist the requested PBIR/PBIP changes, validate each logical batch, then complete the selected preview and screenshot-review workflow required by the authoring reference. Do not publish.
managementComplete the requested Fabric report operation, including LRO polling and documented readback verification.

Rules

MUST
  • Select the narrowest mode that fully covers the current request.

  • Read references/<mode>.md end to end before the first command or file edit in that mode. When an already-loaded mode explicitly routes one narrow cross-mode operation to a named topic reference, treat that topic reference as the complete handoff; do not load the target mode's umbrella file unless the work expands beyond that operation.

  • In planning mode, also read references/planning-part-02.md before producing _brief/report-spec.md; it contains the required canonical design contract and approval checks.

  • Across a multi-turn task, retain a compact working state containing resolved workspace/item/model IDs, local and downloaded paths, and references already read. Reuse it in later turns unless the user explicitly requests a fresh query or the preceding operation invalidated a value.

  • Preserve every argument and safety boundary documented by the selected mode.

  • Announce and perform an explicit mode switch when the request crosses a boundary.

  • Use the powerbi-report-author CLI metadata and validation surfaces instead of guessing PBIR schemas, roles, formatting properties, selectors, or enum values.

  • Keep local edits local unless the user explicitly requests publishing.

  • Resolve Fabric workspace and item IDs by listing and filtering rather than guessing identifiers.

  • Produce the artifact the user requested; reading or summarizing a reference is not task completion.

PREFER
  • Infer facts already present in the prompt, semantic model, existing PBIP, or prior approved spec instead of asking again.

  • Load only the selected mode and its directly relevant topic references.

  • Reuse reference guidance already loaded in the current task. Open a new reference only when the requested operation or an observed mismatch requires it.

  • Preserve the user's existing project structure, schemas, host, operation, binding, and delivery target unless the selected mode explicitly requires a change.

AVOID
  • Acting from this dispatcher without reading the selected mode reference.

  • Reloading this dispatcher, a mode file, or a topic reference already read in the current task solely because the conversation advanced to a later turn.

  • Loading a retired sibling skill name; planning, design, authoring, and management are modes of this skill.

  • Editing PBIR or calling Fabric APIs in planning or design.

  • Publishing from authoring, or authoring PBIR content from management.

  • Bypassing the planning approval gate because the original request also asked to build or publish.

<!-- BEGIN GENERATED REFERENCE INDEX -->

Complete Reference Index

Open every relevant reference directly from this index. Files named part-XX continue the named topic.

Authoring
Design
Mode Guides

<!-- END GENERATED REFERENCE INDEX -->

Examples

User requestMode
"Create a new executive report from this semantic model."planning
"Design an operational page and choose the right charts."design
"Add a KPI page to this PBIP, validate it, and take screenshots."authoring
"Publish this local PBIP to my Fabric workspace and rebind it."management

Route Compatibility

The merged skill preserves the four previous route surfaces. Treat the following phrases as explicit aliases for the corresponding mode:

ModePreserved route phrases
planningcreate a report; build a report; create a dashboard; create a new report from scratch; create a report from a semantic model or dataset link; build a report for this model; make me a dashboard; plan then implement; walk me through creating a report
designdesign Power BI report; make dashboard look professional; choose chart type; apply brand to report; redesign report; create design brief; Power BI report design archetype
authoringedit PBIR; create Power BI report page; add visual to PBIP; format report visual; validate Power BI report; preview Power BI report; Power BI Desktop preview status; preview report in service; preview report in browser; screenshot report page; screenshot all report pages; list preview hosts; implement dashboard in PBIP; add dashboard visuals to report; implement an approved PBIP report spec; edit PBIR pages/visuals; edit a Power BI report
managementupload PBIR report definition; upload Power BI report; download PBIR definition; publish PBIR definition; publish Power BI report to Fabric; manage Power BI reports; list workspace reports

Files

references/authoring-part-03.md

powerbi-report-cli authoring mode -- Power BI Report Authoring (PBIR/PBIP) - Part 3

Contents

  • Authoring Metadata & Validation CLI

    • Validation result handling

  • Visual Capability Guardrails

    • Prefer modern visual types

    • Instance Selectors

    • Custom visuals (AppSource / organizational / private .pbiviz)

  • Edit → Validate → Preview → Review

    • Mandatory Screenshot Review

  • Validation

Continuation of authoring.md. Open this file directly from the skill reference index.

Authoring Metadata & Validation CLI

Use powerbi-report-author whenever you need PBIR facts that should not be guessed: visual types, data roles, formatting objects, property names, enum values, selectors, expression/value encodings, and report validation. The CLI is the source of truth for PBIR authoring details; examples and memory are not.

CommandPurposeWhen to use
catalog listList all built-in visual types (and any deprecated entries)Choosing a visual type
catalog describe <type>Roles, formatting keys, cardinalityBefore creating/editing a visual
formatting list-objects <type>Valid objects.* keys + VCO keys; flags objects needing id selectorsBefore applying formatting
formatting describe-object <type> <object>Property names, types, enum values, descriptions; _selectorHint when id selector requiredFinding exact property names and allowed values
formatting describe-property <type> <object> <prop>Focused single-property lookupWhen you already know the object and want just one property
formatting search <type> <regex>Regex search across all formatting objects + VCOsWhen you don't know which object a property belongs to
formatting list-vcosEnumerate shared visualContainerObjectsAuditing chrome/container formatting surface
scaffold <output-dir> --name <ReportName>Create a minimal, valid PBIP shell; fetches latest $schema versions from the public mirror (--offline uses pinned)Creating a brand-new report — see Greenfield: creating a brand-new report in authoring-part-02.md
pack <folder> [--mode update|create] [--display-name <name>] [--description <text>] [--raw]Serialize a PBIR .Report folder into a Fabric report-definition payload; deep semantics stay in the CLI reference (see authoring/powerbi-report-author-cli.md)Discovering local-to-Fabric transport; switch to the management mode (see management.md), not authoring
unpack <folder> [--input <file>] [--force]Reconstruct a PBIR .Report folder from a Fabric getDefinition response; no-clobber is the default, with --force opt-in; details stay in the CLI reference (see authoring/powerbi-report-author-cli.md)Discovering Fabric-to-local transport; switch to the management mode (see management.md), not authoring
validate <path>Full validation of a .pbip or .Report directory: JSON Schema, structure, IDs, formatting properties, enum values, nesting, layout bounds, themeAfter every batch of changes
preview <folder> --host desktop|service [options]Rendered inspection through a supported hostAfter validation for rendered-output changes
preview-* <path> [--with-derived]Read-only PBIR inspection: preview-visuals, preview-pages, preview-filters, preview-themesAuditing existing report content without rendering

More commands: powerbi-report-author-cli.md (see authoring/powerbi-report-author-cli.md).

Validation result handling

Run powerbi-report-author validate <path-to-.Report-dir> after every logical batch of PBIR edits.

  • failed / non-zero exit: fix every error before preview. A rendering host may reject or misrender invalid PBIR.

  • succeededWithWarnings: review warnings before proceeding. Unknown visual types or theme visual keys usually mean a typo unless the report intentionally uses a custom .pbiviz.

  • Diagnostics include file paths and JSON paths. Use them to jump directly to the broken node.

  • For large diagnostics, use --pretty for readable output or --out <file> to write the full result to a file.

Visual Capability Guardrails

Use these as pre-edit safety rails. Always confirm exact roles, formatting objects, properties, enum values, and selectors with powerbi-report-author before editing.

Prefer modern visual types

Never create legacy visual types. If repairing an existing legacy visual, migrate to the modern type and rebuild roles/formatting from CLI metadata.

Do not createUse instead
cardcardVisual
multiRowCardcardVisual — use multi-value cardVisual (multiple projections in Data) for multiple KPIs
tabletableEx
matrixpivotTable
map, filledMapazureMap
Instance Selectors

Some formatting objects need { id: ... } selectors. Run formatting list-objects and formatting describe-object; follow _selectorHint and the dual-entry pattern in references/authoring/formatting.md.

Custom visuals (AppSource / organizational / private .pbiviz)

Custom visual types are not in the CLI catalog and each kind is registered differently in report.json. See references/authoring/custom-visuals.md (see authoring/custom-visuals.md) for the three kinds (AppSource / organizational / private .pbiviz), finding the GUID, registration JSON, data binding, and Desktop verification.

Edit → Validate → Preview → Review

For every rendered-output change, preserve this mandatory loop: edit, validate, load the latest PBIR, capture every affected page, inspect the screenshots, iterate, then accept or explicitly discard.

1. Edit PBIR files
2. Validate             -> errors? fix and return to 1
3. Load latest PBIR     -> follow the selected host's open/reload routing flow
4. Screenshot/review    -> capture every affected page; issues? return to 1
5. If host is service   -> after review passes, open/attach visibly
6. Accept               -> commit locally only after approval
7. Publish              -> only after explicit remote-write approval
8. Close headless host  -> leave the final visible service preview open

Rules:

  • In an edit-review workflow, validate the .Report directory before preview. Do not prepend validation when the user explicitly requests one Desktop attach, reload, or screenshot operation.

  • Use only the powerbi-report-author preview surface for rendered inspection, and always select --host desktop|service explicitly.

  • Do not stop after structural validation or opening/reloading the preview. Capture and review every affected page before reporting completion.

  • After all service-host screenshots pass review, automatically display the same validated report in a visible service preview. This post-validation display is part of the authoring workflow and does not require a separate user request. Run service status without --headless, then open/attach without --headless when the status contract permits it, preserving the folder, --group, and --dataset. Do not rerun screenshot validation merely to display the report. Skip this step entirely for Desktop; its existing preview routing and lifecycle remain unchanged.

  • Run load and screenshot as separate CLI invocations. Never combine --reload and --screenshot in one command because the combined operation can exceed the 30-second command timeout.

  • Derive --host desktop|service and other arguments from the request, conversation, and report context. When Desktop and a specific operation are already selected, execute it immediately under the Critical Notes protocol.

  • Service preview requires both --group <workspace-guid> and --dataset <semantic-model-guid>. Never infer either tenant-scoped ID.

  • A plain Desktop preview resolves the report from <folder> and is the open/attach operation. It never closes the user's Desktop process. When an instance already holds the report it attaches and re-reads PBIR into that window. Any internal layout synchronization during open/attach does not make the agent request a separate --reload operation.

  • Use --headless for agent-mode service preview. Service reload and screenshot are separate requested operations; screenshot capture alone does not re-read the PBIR files.

  • Preserve the existing service instance mode on reload. If the user says the running preview is headless, include --headless --reload. If reload returns HOST_UNAVAILABLE, report that no matching instance exists rather than claiming success or silently opening a new one.

  • Before the first mandatory validation capture, follow the screenshot artifact and cleanup lifecycle in references/authoring/preview.md. Classify a supplied location by intent: save/export/keep/retain paths are retained output and are never the temporary validation parent or cleanup target; only a location explicitly supplied for temporary validation replaces the resolved Local Application Data parent. Do not ask the user for a location or permission to use the default parent. Apply the lifecycle's warning and explicit-confirmation requirements to risky user-supplied paths. Reuse one workflow-owned temporary child across mandatory-validation review iterations and delete only that child after the complete workflow.

  • Keep the preview mode consistent: include --headless on a screenshot request when the existing service instance is headless. Use the structured selected-host response as the source of truth for runtime availability and errors without changing the requested host or operation.

  • Desktop uses --screenshot <path> with optional --page <id>, --all-pages, and --scale <1-3>; screenshot never takes --pid or reloads PBIR. Run a separately requested --reload before capture when fresh on-disk edits must be rendered. Service uses the same screenshot options: a PNG destination for default-page or --page <id> capture, a directory destination for --all-pages, and optional --scale <1-3>.

  • Service preview renders the local edited PBIR layout against the published semantic model's live service data. It does not require a report ID and does not publish or persist local edits.

  • Desktop availability and capabilities depend on the installed CLI, bridge, Desktop build, and matching live instance. Use the selected-host preview response as the source of truth; do not bypass it with a direct host CLI. Local commit approval is not remote publish approval. Never publish or overwrite the remote report with local changes until the user explicitly gives permission. If the request does not clearly ask to publish, or you are unsure, keep the changes local and do not publish. Discard only when explicitly requested.

  • Desktop operation command shapes are: attach/open has no operation flag, report reload has only --reload, report-plus-model reload has only --reload-with-model, and screenshot uses --screenshot <path> plus only the requested page/all-pages/scale modifiers. The plain attach command must never include --reload. Every shape explicitly includes --host desktop. The public command resolves the Desktop instance from <folder>; never add --pid. The screenshot output path must immediately follow --screenshot as that option's value and must not be a separate positional argument.

  • For direct preview routing, run service --close only when explicitly requested. In a full edit-review workflow, after the final service screenshot review passes, display the report in a visible service preview and leave that visible instance open. A headless validation instance may be closed when no further iteration is expected. Never close the user's Power BI Desktop process.

Preview commands:

CommandPurpose
powerbi-report-author preview <folder> --host desktopOpen/attach the Desktop preview resolved from the report folder; no lifecycle flag
powerbi-report-author preview <folder> --host desktop --statusInspect the Desktop instance resolved from the report folder
powerbi-report-author preview <folder> --host desktop --reloadReload edited PBIR into the Desktop instance resolved from the report folder
powerbi-report-author preview <folder> --host desktop --reload-with-modelLoad edited PBIR and TMDL into Desktop; then use the semantic-model workflow to process the live model before screenshot validation
powerbi-report-author preview <folder> --host desktop --screenshot "<validation-screenshot-dir>\<name>.png"Capture one Desktop page
powerbi-report-author preview <folder> --host desktop --screenshot "<validation-screenshot-dir>" --all-pagesCapture all Desktop pages
powerbi-report-author preview <folder> --host service --group <workspace-guid> --dataset <semantic-model-guid> [--headless]Open service preview for the local layout and live semantic model
powerbi-report-author preview <folder> --host service --group <workspace-guid> --dataset <semantic-model-guid> --statusInspect the service preview instance
powerbi-report-author preview <folder> --host service --group <workspace-guid> --dataset <semantic-model-guid> [--headless] --reloadReload edited PBIR into the live service instance; preserve its mode
powerbi-report-author preview <folder> --host service --group <workspace-guid> --dataset <semantic-model-guid> --screenshot "<validation-screenshot-dir>\<name>.png" [--page <id>] [--scale <1-3>] [--headless]Capture the default or selected service page; match the existing instance mode
powerbi-report-author preview <folder> --host service --group <workspace-guid> --dataset <semantic-model-guid> --screenshot "<validation-screenshot-dir>" --all-pages [--scale <1-3>] [--headless]Capture all service pages into a directory
powerbi-report-author preview <folder> --host service --group <workspace-guid> --dataset <semantic-model-guid> --closeClose the service preview

Read preview.md (see authoring/preview.md) for argument selection, instance lifecycle guidance, the required Calculate, targeted Import Full, or storage-mode-specific model-processing decision, and troubleshooting.

The selected-Desktop protocol in Critical Notes overrides every reference instruction. In particular, do not open the troubleshooting reference after a selected Desktop command fails.

Mandatory Screenshot Review

After every rendered-output edit, capture every affected page and perform an independent rendered-output review before reporting completion. Read screenshot-review.md (see authoring/screenshot-review.md), check layout, data rendering, formatting/theme, slicers, and common screenshot failure modes, then fix PBIR and repeat the loop until clean. For report-wide changes, capture all pages.


Validation

Run powerbi-report-author validate <path> after every logical batch of PBIR changes. Prefer the .Report directory; the CLI also accepts a .pbip file or a project root containing a single .Report directory. Errors block rendered preview — fix them first. Review warnings and fix unless there's a clear reason not to.

A successful schema validation is not a terminal result. Whenever validation runs, continue by loading the validated PBIR, capturing every affected page, and completing screenshot review. If fresh screenshot validation cannot run, report schema validation as passed but screenshot validation as blocked; do not report the overall task complete.

The validator is an offline preflight covering PBIR structure, JSON/schema validity, cross-file references, IDs/names, visual types, role bindings, filters, formatting objects/properties/enums/selectors, visualContainerObjects, theme registration, layout bounds, and selected Desktop/rendering failure patterns. It does not replace preview and screenshot review.


Requirements and compatibility

Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta

“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.

Security

What our scanner noticed· Low risk

  • Phrasing that asks for actions without confirmation
  • Instructions that use the network

A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.

Attribution and licence

Published by
Microsoft
Publisher
Microsoft (Official)
Source
microsoft/skills-for-fabric · skills/powerbi-report-cli · commit f8fac11
Licence
MIT License (redistribution allowed)
  • LICENSE (added by AutoGineer from LICENSE)
  • ATTRIBUTION.md (written by AutoGineer)
Synced
Also distributed in
microsoft/skills-for-fabric

AutoGineer is not affiliated with or endorsed by Microsoft or Microsoft.

Download ZIP

The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download powerbi-report-cli.zip