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-04.md

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

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

Anti-Patterns and Pitfalls

PitfallConsequenceFix
Using "Entity" inside filter Where conditionsFilter silently failsUse "Source" with the alias from From
Omitting nativeQueryRefVisual calculations may breakAlways include nativeQueryRef
Reusing visual/filter namesUnpredictable behaviorGenerate unique IDs
Setting visualType to invalid stringVisual renders as error boxRun powerbi-report-author catalog describe <type> or powerbi-report-author catalog list
Adding a private .pbiviz by only unpacking it into CustomVisuals/Visual renders "To see this custom visual, add it to this report first"; validate flags it with a PBIR_VISUAL_TYPE_UNKNOWN warning because the GUID isn't registeredAlso register it in report.json → resourcePackages with type: "CustomVisual" — see custom-visuals.md (see authoring/custom-visuals.md)
Wrong role name for visual typeField is ignored; visual blankMatch role names from powerbi-report-author catalog describe <type>
Mixing Column and Measure typesQuery fails; visual errorColumns use Column, measures use Measure
Forgetting to add page to pages.jsonPage invisibleAdd to pageOrder array
Creating a bookmark file without updating bookmarks.json, or leaving stale page/visual/filter IDs in saved stateBookmark is absent, disabled, or silently applies incomplete stateFollow bookmark.md (see authoring/bookmark.md); validate every bookmark and action target before Desktop reload
Booleans without correct formatWrong type"true" / "false" (no suffix, unquoted in Value)
Numbers without type suffixType mismatchD for decimals, L for integers
Editing $schema versionPBI Desktop may rejectPreserve existing version
Stringified JSON in paragraphsTextbox shows nothingparagraphs is a native JSON array
Using textbox as a thin line/dividerRenders ~24px tall regardless of heightUse a shape visual (rectangle) instead — shapes respect small dimensions
visualContainerObjects as sibling of visualSchema validation error in PBI DesktopMust be inside visual object, as sibling of objects
Using tableEx with dimension columns and measures all in ValuesHeaders render but no data rows even when DAX confirms data existsUse pivotTable; put dimensions in Rows and measures in Values
Using PowerShell ConvertTo-Json to edit visual JSONProperty reordering, nesting depth truncation (-Depth default is 2)Use Node.js for JSON manipulation, or always pass -Depth 20 and verify structure
Using regex or string replacement to modify JSON filesCorrupts nesting structure — properties end up inside sibling values, braces misalignRead file → JSON.parse → modify object → JSON.stringify → write back. Or use the edit tool with exact old/new string matching
dataPoint.fill without a selector on single-series chartsBars/columns invisible despite data in tooltipsUse dataPoint.defaultColor for a base color without a selector; fill requires a metadata selector
Using dataPoint.defaultColor on multi-series chartsAll series/categories get the same color — no visual differentiationUse theme dataColors for consistent palette across visuals, or dataPoint.fill with metadata selectors for per-series overrides — see color-strategy.md § Color Strategy Quick Reference (see authoring/color-strategy.md, section color-strategy-quick-reference)
Clustered bar/column chart colors collapse into one legend colorThe visual has a Series role but all bars and legend markers share the same hueUse per-series dataPoint.fill selectors or a theme dataColors palette; do not use defaultColor on clustered charts
Relying on theme dataColors alone for cross-visual measure consistencySame measure gets different colors on different visuals (index-based assignment varies with projection order)Maintain a measure→color mapping and apply explicit dataPoint.fill/defaultColor per visual — see color-strategy.md § Cross-Visual Measure-Color Consistency (see authoring/color-strategy.md, section pattern-cross-visual-measure-color-consistency)
Using ThemeDataColor for explicit per-measure dataPoint.fill with metadata selectorsColors silently resolve to white or black instead of expected palette colorUse Literal hex values for explicit color assignments with metadata selectors — ThemeDataColor is unreliable in this context
Choosing bar/series colors without checking background contrastBars or lines invisible against page/card background (e.g., white bars on white canvas)Always pick saturated, mid-to-dark hues that contrast with the page and VCO background colors
show property on page-level backgroundSchema error — page background only supports color, image, transparencyOnly VCO background (on visuals) has show; page background is always visible
Copying property names from doc examples without verifyingWarnings or silent failures — property names vary by visual typeAlways run powerbi-report-author formatting describe-object <type> <object> for exact property names
Guessing which object a property belongs toWasted calls checking wrong objects one by oneRun powerbi-report-author formatting search <type> <regex> to grep across all objects at once
Formatting property has no effect (no error)Setting show: false on cardVisual outline without an id selector — validates but renders unchangedCheck powerbi-report-author formatting describe-object <type> <object> for _selectorHint; use the dual-entry pattern (static + id selector entries)
Using cardCalloutArea on a single-value cardProperties validate but have no visible effect — cardCalloutArea only renders on multi-value cards (2+ measures in Data)Use outline/accentBar/fillCustom with { id: "default" } selector for single-value cards. For multi-value cards, cardCalloutArea controls per-callout tile styling — see card.md § Multi-Value Formatting (see authoring/card-part-03.md, section multi-value-formatting)
Using "Fields" as the queryState role for cardVisualCards render empty — PBI Desktop cannot resolve the binding. Validator reports Unknown role "Fields" and Required role "Data" missingcardVisual's only data role is "Data". "Fields" is the legacy card visual's role name — never carry it over. Always verify role names with powerbi-report-author catalog describe cardVisual — see card.md § Single-Value Template (see authoring/card.md, section single-value-template)
Creating separate single-value cardVisual instances for multiple related KPIsWastes canvas space and misuses the visual type — cardVisual natively supports multiple projections in one tileDefault to one multi-value cardVisual with all measures as Data projections when ≥2 related KPIs are requested. Only use separate cards when per-card styling differences are required — see card.md § When to Consolidate vs. Keep Separate (see authoring/card-part-03.md, section when-to-consolidate-vs-keep-separate)
Adding multiple fields to button slicer Values or Label rolesSlicer breaks or shows unexpected results — each role accepts only 1 fieldPut one field in Values, one in Label; additional fields go to Tooltips
Looking at filterConfig on other visuals to understand slicer selectionsSlicer selections live only inside the slicer's own visual.json via expansionStates + objects.general.filter. Always read references/authoring/slicers.md first when modifying slicers
Creating an image visual without prompting for the source typeWrong visual structure — URL vs local file vs data field each have different schemas and expression typesAlways ask the user for the image source (local file / URL / data field) before creating the visual — see image.md § Source Types Overview (see authoring/image.md, section source-types-overview)
KPI Indicator bound to a column instead of a measureVisual goes blank with no errorIndicator role requires kind: Measure — use a DAX measure or an Aggregation expression; see kpi.md § Why KPI Goes Blank (see authoring/kpi.md, section why-kpi-goes-blank)
KPI TrendLine bound to a text or category columnVisual goes blank or sparkline disappearsTrendLine requires a date, datetime, or monotonically increasing numeric column; never bind a text/category field — see kpi.md § Why KPI Goes Blank (see authoring/kpi.md, section why-kpi-goes-blank)
KPI Indicator measure returns BLANK at the latest trend point (e.g. date table extends into future)Visual goes blank silentlyWrap the measure with LASTNONBLANK or COALESCE; see kpi.md § Why KPI Goes Blank (see authoring/kpi.md, section why-kpi-goes-blank)
KPI Goal measure granularity does not align with Indicator trend granularityTarget renders blank or zero; status direction wrongEnsure the Goal measure evaluates at the same time grain as the Indicator — see kpi.md § Why KPI Goes Blank (see authoring/kpi.md, section why-kpi-goes-blank)
Creating a data-bound image visual with a field that lacks dataCategory: ImageUrlVisual renders blank or errorWarn the user first — the visual will render blank without dataCategory: ImageUrl. Present alternatives (other ImageUrl fields, local file, URL) and confirm before creating — see image.md § Select from data (see authoring/image.md, section 3-select-from-data)
Placing background image on page canvas instead of visual plot areaUser asks for "background image" alongside a visual (e.g., "column chart with background image") but image is placed on page.json → objects.background instead of visual.objects.plotAreaWhen a background image is requested in the context of a specific visual, default to plotArea.image. Only use page-level background.image when the user explicitly says "page background" / "canvas background" or no visual context exists — see image.md § Plot Area Background Image (see authoring/image.md, section plot-area-background-image-plotareaimage)
Creating a multiRowCard visualLegacy multi-row card — deprecated; powerbi-report-author validate warns with PBIR_VISUAL_TYPE_DEPRECATED. Often triggered by user phrases like "multi-card", "cards for each metric", or "card per measure"Always use cardVisual. For multiple KPIs, use a single multi-value cardVisual with all measures as projections in the Data role — see card.md (see authoring/card.md, section multi-value-template)
Using map or filledMap instead of azureMap for map visualsLegacy Bing Maps visuals — deprecated and must not be created; powerbi-report-author validate warns with PBIR_VISUAL_TYPE_DEPRECATEDAlways use azureMap — see map.md (see authoring/map.md). If the map fails to render or geocode, debug the fields, try alternative geographic columns/coordinates, or ask the user — do not silently substitute a non-map visual without consulting the user first
Creating tableEx/pivotTable without columnAdjustment: growToFitColumns shrink-wrap to content, leaving unused whitespaceAlways set columnHeaders.columnAdjustment to growToFit and autoSizeColumnWidth to true — see table.md (see authoring/table.md, section default-rule--grow-to-fit)
Custom table/matrix row colors with no effect (white background)Default style preset overrides objects-level backColorPrimary/backColorSecondarySet stylePreset VCO to 'None' on every tableEx/pivotTable with custom colors — see table.md § Style Presets (see authoring/table.md, section style-presets-for-tables)
Table cells white despite dark VCO backgroundvisualContainerObjects.background only controls outer container — table cells paint on topSet dark colors in objects.values.backColorPrimary/Secondary and objects.columnHeaders.backColor, not in VCO — see re-theming.md § Dark Mode Checklist (see authoring/re-theming-part-03.md, section dark-mode-authoring-checklist)
Dark theme applied but cards/tables/slicers still whiteDark mode triggers every formatting trap simultaneouslyFollow the full re-theming.md § Dark Mode Authoring Checklist (see authoring/re-theming-part-03.md, section dark-mode-authoring-checklist) — covers stylePreset, fillCustom+id selector, objects vs VCO, and contrast audit
Theme JSON changes do not appear after preview reloadTheme registration is stale, or a host cached the theme file nameRename the theme JSON with a small random suffix, update the theme registration in report.json, validate, then follow the host-specific reload workflow in preview.md (see authoring/preview.md)
Placing sortDefinition inside visual or at root of visual.jsonSchema validation error; sort silently ignored — chart falls back to alphabeticalsortDefinition is a property of query — use visual.query.sortDefinition. Supported since visualConfiguration/2.2.0
Container shape fill doesn't match referenceText invisible or wrong background colorMatch the fill color and transparency to the reference image. If the page background already provides the color, skip the shape entirely. If the shape must be invisible, verify text color still contrasts with the page canvas — see shape.md § Container Shapes (see authoring/shape.md, section container-shapes)
Shape text invisible after re-themeShape text object has no explicit fontColor — text inherits theme foreground, but when fill is a light color (e.g., white pill/button) on a light page canvas, inherited dark foreground may not render or the fill blends with canvas making text vanishAlways set explicit fontColor on shape text objects (in the { selector: { id: "default" } } entry). During re-theming, audit all shapes with text.show: true — bulk hex-replacement misses shapes that need a new fontColor property added
Enabling logAxisScale on data with zero or negative valuesPBI Desktop silently falls back to linear scale with a warning — log of zero/negative is undefinedWarn the user before applying. Use ask_user to present alternatives (filter negatives, switch measure, use labelDisplayUnits). Apply logAxisScale: true only after the user resolves negative values or confirms all bound values are positive — see cartesian.md § Log Scale (see authoring/cartesian-part-02.md, section log-scale-logaxisscale)
Changing theme without sweeping inline overridesOld colors remain on shapes, page backgrounds, nav buttons, textboxes — theme-only change has no effect on hardcoded Literal hex values at Priority 2 in the cascadeWhen the report has per-visual color overrides, follow re-theming.md § Re-theming Workflow (see authoring/re-theming-part-02.md, section re-theming-an-existing-report) Steps 0–3: build a color mapping, update theme JSON, then bulk-sweep definition/ files for old hex values before preview
Changing only dataColors in theme without sweepingShapes, accent bars, nav button borders retain old accent colors — they use hardcoded Literal hex from the old dataColors array, not ThemeDataColor referencesSweep ALL old dataColors[N] hex values across definition/ files. Even same-polarity "just change the accent/data colors" requests need the full sweep — shapes and nav elements commonly hardcode dataColors[0] as accent fills/outlines.

Official Documentation

For Microsoft Learn setup guidance, support constraints, and feature availability, use Power BI report authoring docs.

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