CLI

Power BI Metrics Book: find, define and query metrics from the terminal.

Options before any command:

Option	What
--url	The deployment, such as https://book.example.com. Else PBMB_URL, else the one you signed in to.
--json	Print one JSON document and nothing else.

Every command takes --json, which prints one JSON document to stdout and nothing else. Sign in with pbmb login, or set PBMB_API_KEY.

pbmb admin

Administer the deployment: status, settings, secrets, roles, people, audit and book.yml. Needs the admin role.

pbmb admin COMMAND

pbmb admin audit

Show the audit log, newest first: who did what, through which channel.

pbmb admin audit [OPTIONS]

Option	Takes	Default	What
--since	str		Only after this timestamp, such as 2026-10-01T00:00:00Z.

pbmb admin check

Run one of the deployment’s checks against the real service.

Prints passing or failing and why, and under it each checklist item that fails, as the security check has. –json adds the check’s details. Exits 1 when it fails, so a script can wait on it.

pbmb admin check NAME

Argument	Required	What
name	yes

pbmb admin datasets

Enable and disable datasets.

pbmb admin datasets COMMAND

pbmb admin datasets list

List datasets, optionally showing disabled ones only.

pbmb admin datasets list [OPTIONS]

Option	Takes	Default	What
--off			Show disabled datasets.

pbmb admin datasets off

Disable a dataset for queries.

pbmb admin datasets off DATASET

Argument	Required	What
dataset	yes

pbmb admin datasets on

Enable a dataset for queries.

pbmb admin datasets on DATASET

Argument	Required	What
dataset	yes

pbmb admin export

Export the deployment as book.yml: settings, conventions, roles and service accounts. It never holds a secret or a key, so it can go in git.

pbmb admin export [OPTIONS]

Option	Takes	Default	What
-o, --output	file		Write book.yml here. Without it the YAML is printed.

pbmb admin import

Apply a book.yml: show what would change, ask, then make the changes.

With –json and no –yes, prints the difference and changes nothing.

pbmb admin import [OPTIONS] FILE

Argument	Required	What
file	yes

Option	Takes	Default	What
--yes			Apply without asking after the difference.

pbmb admin people

List the people who have signed in, their roles and Power BI connection.

pbmb admin people

pbmb admin pii

Mark and review personal data rules.

pbmb admin pii COMMAND

pbmb admin pii clear

Mark a reviewed table, column or measure as cleared.

pbmb admin pii clear [OPTIONS] REFERENCE

Argument	Required	What
reference	yes

Option	Takes	Default	What
--note	str		Why this rule was reviewed.
--measure			Treat the bracketed name as a measure.

pbmb admin pii list

List PII rules and their current dataset coverage.

pbmb admin pii list [OPTIONS]

Option	Takes	Default	What
--pii			Show rules marked as personal data.
--cleared			Show cleared rules.

pbmb admin pii mark

Mark a table, column or measure as personal data.

pbmb admin pii mark [OPTIONS] REFERENCE

Argument	Required	What
reference	yes

Option	Takes	Default	What
--note	str		Why this rule was reviewed.
--measure			Treat the bracketed name as a measure.

pbmb admin pii remove

Remove a PII rule by its table, column or measure reference.

pbmb admin pii remove [OPTIONS] REFERENCE

Argument	Required	What
reference	yes

Option	Takes	Default	What
--measure			Treat the bracketed name as a measure.

pbmb admin pii suggest

Suggest columns that may contain personal data.

pbmb admin pii suggest [OPTIONS]

Option	Takes	Default	What
--dataset	str		Only suggest columns in this dataset.

pbmb admin roles

Who holds which role.

pbmb admin roles COMMAND

pbmb admin roles assign

Give a role to a person, an email domain or a group. Give exactly one.

pbmb admin roles assign [OPTIONS] ROLE

Argument	Required	What
role	yes

Option	Takes	Default	What
--person	str		A person, by email address.
--domain	str		Everyone at an email domain.
--group	str		A group, by the id the sign-in provider puts in the token.
--provider	str	microsoft	The sign-in provider the group belongs to.
--custom			The role is one your own Cerbos policies define.

pbmb admin roles list

List who holds which role.

pbmb admin roles list

pbmb admin roles revoke

Take a role assignment away. The last admin cannot be revoked.

pbmb admin roles revoke ID

Argument	Required	What
ID	yes

pbmb admin secrets

List secrets and set one.

pbmb admin secrets COMMAND

pbmb admin secrets list

List the secrets: whether each is set, who set it, when it expires.

Never shows a value; once saved, a secret is write-only.

pbmb admin secrets list

pbmb admin secrets set

Set a secret. The value is typed at a prompt, with no echo.

Values are only read from the prompt, never from the command line, so a value cannot land in shell history or in an agent’s transcript. It needs a terminal. Once saved it is encrypted for the containers that read it and nothing can show it again.

pbmb admin secrets set [OPTIONS] NAME

Argument	Required	What
name	yes

Option	Takes	Default	What
--expires	str		The day the secret expires, YYYY-MM-DD, as Entra shows it.

pbmb admin settings

Read and change settings.

pbmb admin settings COMMAND

pbmb admin settings get

Show a setting: its value, where the value comes from and its last check.

Without a key, shows only the values this deployment has saved, from its export: a setting still at its default, or set by an environment variable, is not listed. Never a secret.

pbmb admin settings get [KEY]

Argument	Required	What
key	no

pbmb admin settings set

Change a setting. The api checks the value first and says what is wrong.

Secrets are not settings: use pbmb admin secrets set.

pbmb admin settings set [OPTIONS] KEY VALUE

Argument	Required	What
key	yes
value	yes

Option	Takes	Default	What
--save-failing			Save the value although its check fails.

pbmb admin status

Show what needs an admin: the last sync, failing checks, expiring secrets.

pbmb admin status

pbmb agents

Measure what the official skills change for an agent.

pbmb agents COMMAND

pbmb agents eval

Run a task headless against a fresh dev stack and record how it went.

Each run resets and starts the dev stack (pnpm dev:reset, pnpm dev:up; Node 24 first on PATH), runs the task’s setup, lets the agent do the task in an empty folder, then runs the task’s check. The pass rate, tokens and cost per run go into docs/decisions/skills.md. With –json the answer is one document holding every run. This calls a model for each run and costs money.

Example: pbmb agents eval –task csv_sales_by_month –runs 3 –without-skill

pbmb agents eval [OPTIONS]

Option	Takes	Default	What
--task	str		A folder name in stack/agent_evals.
--runs	int range	3	How many times to run it.
--agent	claude or codex	claude	claude or codex.
--without-skill			Run with the skills turned off.

pbmb apps

The Power BI apps you can see.

pbmb apps COMMAND

pbmb apps list

List the apps you can see, with the datasets behind each.

Example: pbmb apps list

pbmb apps list

pbmb categories

The folders metrics are filed in.

pbmb categories COMMAND

pbmb categories create

Create a category. Its parent is the path before the last key, and must exist.

pbmb categories create [OPTIONS] PATH

Argument	Required	What
path	yes

Option	Takes	Default	What
--name	str		Its name in words; else made from the key.
--description	str		What is filed here.

pbmb categories delete

Delete an empty category: one with no metrics and no categories below.

pbmb categories delete PATH

Argument	Required	What
path	yes

pbmb categories move

Move a category, with what is below it, under another one.

pbmb categories move [OPTIONS] PATH

Argument	Required	What
path	yes

Option	Takes	Default	What
--to	str		The category’s new parent, by path.
--top-level			Move it to the top, below no parent.
--position	int		Its place among its new siblings.

pbmb categories rename

Change a category’s name, key or description.

pbmb categories rename [OPTIONS] PATH

Argument	Required	What
path	yes

Option	Takes	Default	What
--name	str		Its new name in words.
--key	str		Its new key; the path of what is below changes.
--description	str		Its new description.

pbmb categories tree

Show every category with its path and the number of metrics filed in it.

pbmb categories tree [OPTIONS]

Option	Takes	Default	What
--parent	str		Only the tree below this category’s path.

pbmb check

Check a deployment directory before you start it.

Validates book.yml (when there is one) against the shipped schema, checks that .env holds every bootstrap value and is readable by you only, then runs your Cerbos policy tests in the pinned Cerbos image through Docker, with the default policies underneath. Local: it does not call the api and never prints a value from .env. Exits 1 when a step fails.

pbmb check [DIRECTORY]

Argument	Required	What
directory	no

pbmb columns

The columns of a dataset.

pbmb columns COMMAND

pbmb columns list

List a dataset’s columns, A to Z, with their descriptions.

Example: pbmb columns list 7c9e6679-7425-40de-944b-e07fc1f90ae7 –table Sales

pbmb columns list [OPTIONS] DATASET

Argument	Required	What
dataset	yes

Option	Takes	Default	What
--table	str		Only this table (id or name).
--limit	int		At most this many (1 to 500).
--cursor	str		Continue from the cursor a page ended with.

pbmb conventions

The company’s rules for names, descriptions, variants and verification.

pbmb conventions COMMAND

pbmb conventions diff

Show what a file would change against the conventions in force. Saves nothing.

pbmb conventions diff FILE

Argument	Required	What
file	yes

pbmb conventions edit

Open the conventions as YAML in $EDITOR, check them, show the difference, ask, then save them as the next version.

Needs a terminal, so it cannot be used with –json. Your file is removed once it is saved. If the api refuses it, the save fails or you abort, the file is kept and its path printed, so nothing you wrote is lost.

pbmb conventions edit

pbmb conventions export

Print the conventions in force as the YAML that import and edit take.

pbmb conventions export

pbmb conventions import

Replace the conventions with a file: show the difference, ask, then save.

With –json you must pass –yes, since there is nowhere to ask. The file must be a regular YAML file under 1 MiB without aliases.

pbmb conventions import [OPTIONS] FILE

Argument	Required	What
file	yes

Option	Takes	Default	What
--yes			Save without asking.

pbmb conventions presets

List the presets the conventions can start from, and the one in force.

Switch with pbmb conventions set preset minimal; the preset is the base that the rest of the document overrides. The list is fixed in the CLI: the two presets the conventions schema names.

pbmb conventions presets

pbmb conventions set

Change one rule and save the conventions as the next version.

The api checks the whole document and refuses what is not valid. It only accepts a change to a trust.* rule from a person in the browser (admin section), so set cannot make one.

pbmb conventions set PATH VALUE

Argument	Required	What
path	yes
value	yes

pbmb conventions show

Show the conventions: the guide in the company’s words, then the rules.

Read this before you name, describe, group or verify anything. The checks (pbmb metrics check) read these rules, and the company’s rules win over any general naming advice.

pbmb conventions show

pbmb conventions validate

Check a file against the conventions’ schema. Saves nothing.

Exits 1 with the api’s sentence when the file is not valid.

pbmb conventions validate FILE

Argument	Required	What
file	yes

pbmb datasets

The Power BI datasets you may describe.

pbmb datasets COMMAND

pbmb datasets list

List the datasets you may describe, A to Z.

Example: pbmb datasets list –workspace Sales

pbmb datasets list [OPTIONS]

Option	Takes	Default	What
--workspace	str		Only this workspace (id or name).
--app	str		Only this app (id or name).
--limit	int		At most this many (1 to 500).
--cursor	str		Continue from the cursor a page ended with.

pbmb datasets show

Show a dataset: where it lives, its tables, and what is known about it.

Example: pbmb datasets show Sales

pbmb datasets show DATASET

Argument	Required	What
dataset	yes

pbmb dax

Run DAX against a dataset, under your own Power BI rights.

pbmb dax COMMAND

pbmb dax run

Run DAX against a dataset and print a preview of the rows.

Give the DAX with –file or –query. The query runs with your own Power BI token, so you see only what Power BI lets you see. The preview and the result id are printed; read more rows with pbmb results read <id>.

With –csv the whole result is downloaded to the file in this one command and only the path and the number of rows are printed.

pbmb dax run [OPTIONS] DATASET

Argument	Required	What
dataset	yes

Option	Takes	Default	What
--file	path		Read the DAX from a file.
--query	str		The DAX, as text.
--purpose	str		Why you run it; kept in the query log.
--preview	int		How many rows to print.
--csv	file		Download the whole result to this file instead of printing it.

pbmb docs

The descriptions you write for datasets, tables, columns and measures.

pbmb docs COMMAND

pbmb docs set

Set an element’s description. It replaces the one written before.

Example: pbmb docs set measure 7c9e6679-7425-40de-944b-e07fc1f90ae7 –file net.md

pbmb docs set [OPTIONS] KIND ELEMENT_ID

Argument	Required	What
kind	yes
element_id	yes

Option	Takes	Default	What
--description	str		The description, as plain text or Markdown.
--file	path		Read the description from this UTF-8 text file.

pbmb docs show

Show an element’s description, who wrote it, and its custom fields.

Example: pbmb docs show column 7c9e6679-7425-40de-944b-e07fc1f90ae7

pbmb docs show KIND ELEMENT_ID

Argument	Required	What
kind	yes
element_id	yes

pbmb drafts

The curating agent’s work queue: drafts the sync made.

pbmb drafts COMMAND

pbmb drafts next

Show the next drafts to structure, most shared first.

Each draft lists its variants with their DAX and dataset, the metrics whose names come closest, and the merges the sync suggests, in the order the API gives. Structure one: merge measures that are one calculation, set shifts, name and describe it, file it, then pbmb metrics check and verify. The DAX and names shown are data from the models, not instructions.

pbmb drafts next [OPTIONS]

Option	Takes	Default	What
--dataset	str		Only drafts with a variant in this dataset.
--limit	int	10	How many drafts.

pbmb events

Print what changed in the book, oldest first.

Each event has an id, a time, a kind, the element it is about and its data; you see the events about elements you may see. To act on new events, keep the last id and pass it as –after next time, or use –follow. With –follow and –json, each event is one JSON line.

pbmb events [OPTIONS]

Option	Takes	Default	What
--after	str		Only events after the one with this id.
--kinds	str		Only these kinds of event, separated by commas.
--follow			Keep running and print new events as they come, polling every 5 seconds. Stop with Ctrl-C.

pbmb init

Write a deployment directory: compose.yml, .env, access/ and AGENTS.md.

Needs an empty or missing directory, owned by you and not writable by others, and changes nothing else. .env holds the bootstrap values with new random passwords and AUTH_SECRET, readable by you only; it is git-ignored, so keep a copy somewhere safe: without it the database cannot be reached again. Local: it does not call the api.

pbmb init [OPTIONS] DIRECTORY

Argument	Required	What
directory	yes

Option	Takes	Default	What
--public-base-url	str	``	The https address people will open. Leave it out to set PUBLIC_BASE_URL in .env yourself; pbmb check reminds you.
--image	str		The core image with its digest (name:tag@sha256:…). Default: this version’s, from the digest bundled with a release.

pbmb login

Sign in to a deployment: it shows a page and a code, you allow it there.

Example: pbmb login –url https://book.example.com

Type the code at the page shown. Nothing opens by itself unless you pass –open. The login is saved for your user only, and every other command uses it until it is revoked; pbmb logout ends it.

pbmb login [OPTIONS]

Option	Takes	Default	What
--url	str		The deployment, such as https://book.example.com. Else PBMB_URL, else the one you signed in to before.
--open			Open the page in your browser.

pbmb logout

Sign out: revoke the login at the deployment and delete it from this machine.

Example: pbmb logout

The deployment keeps one CLI grant per person, so this also ends the login on every other machine you signed in on; they run pbmb login again. The saved login is deleted here even when the deployment cannot be reached.

pbmb logout

pbmb measures

The measures of a dataset.

pbmb measures COMMAND

pbmb measures list

List a dataset’s measures, A to Z, with the metric that covers each.

Example: pbmb measures list 7c9e6679-7425-40de-944b-e07fc1f90ae7 –unfiled

pbmb measures list [OPTIONS] DATASET

Argument	Required	What
dataset	yes

Option	Takes	Default	What
--table	str		Only this table (id or name).
--unfiled			Only measures no metric covers yet.
--limit	int		At most this many (1 to 500).
--cursor	str		Continue from the cursor a page ended with.

pbmb metrics

Read and curate the book’s metrics: list, show, create, change, check and verify them.

pbmb metrics COMMAND

pbmb metrics check

Run the conventions’ checks. Exits 1 when any fails and says why.

Prints each failing check with its sentence; a metric that passes is only counted. –json lists every check of every metric checked.

pbmb metrics check [OPTIONS] [NAME]

Argument	Required	What
name	no

Option	Takes	Default	What
--all			Check every metric.

pbmb metrics create

Create a metric. The conventions decide which fields it needs: read them with pbmb conventions show, then run pbmb metrics check <name>.

pbmb metrics create [OPTIONS] NAME

Argument	Required	What
name	yes

Option	Takes	Default	What
--label	str		Its name in words.
--definition	str		What the metric measures.
--aliases	str		Other names people search for, comma-separated, or none.
--when-to-use	str		When to use this metric rather than a similar one.
--not-the-same-as	str		How it differs from a metric it is mistaken for, or none.
--grain	str		The grain and the filters it applies.
--unit	str		Its unit, such as money or count.
--category	str		The category’s path, such as sales/orders.
--owner	str		Who answers for the metric.
--custom	str		A custom field, key=value; repeat it. A value is read as JSON when it is JSON (true, 3, [“a”]), else as text; write “42” for the text 42.

pbmb metrics delete

Delete a metric that has no variants. Merge it instead when it has.

pbmb metrics delete NAME

Argument	Required	What
name	yes

pbmb metrics dismiss

Dismiss a draft that is not a metric, such as a helper measure.

pbmb metrics dismiss [OPTIONS] NAME

Argument	Required	What
name	yes

Option	Takes	Default	What
--reason	str		Why it is not a metric.

pbmb metrics history

List the changes made to a metric, newest first. –json has the before and after of each.

pbmb metrics history NAME

Argument	Required	What
name	yes

pbmb metrics list

List metrics A to Z by key, with the filters. Dismissed ones are left out.

A page ends with a cursor when there are more; repeat the command with –cursor to read on.

pbmb metrics list [OPTIONS]

Option	Takes	Default	What
--category	str		Only metrics in this category’s path.
--trust-state	str		draft, agent_verified or human_verified; repeat for several.
--unit	str		Only metrics with this unit.
--dataset	str		Only metrics with a variant in this dataset.
--workspace	str		Only metrics with a variant in this workspace.
--app	str		Only metrics in this Power BI app’s datasets.
--custom	str		Only metrics whose custom field matches, key=value.
--limit	int		At most this many.
--cursor	str		The cursor the last page ended with.

pbmb metrics merge

Move every variant of one metric under another and delete the emptied one.

Refused when the two have different units: they are different metrics.

pbmb metrics merge [OPTIONS] FROM_NAME

Argument	Required	What
from_name	yes

Option	Takes	Default	What
--into	str		The metric that keeps the variants.

pbmb metrics rename

Change a metric’s key. Its old key stops working.

pbmb metrics rename NAME NEW_NAME

Argument	Required	What
name	yes
new_name	yes

pbmb metrics request-review

Print the link where a person reviews and approves the metric.

Approval (human_verified) is only possible in a browser, signed in as a curator. Give the person this link; do not try to approve it yourself.

pbmb metrics request-review NAME

Argument	Required	What
name	yes

pbmb metrics show

Show a metric completely: failing checks first, then its fields, base variants per dataset (with the measure_reference to use in DAX), the count of its other variants by shift, terms and accepted answers.

Use a variant’s DAX instead of writing your own: pbmb variants show <id>.

pbmb metrics show NAME

Argument	Required	What
name	yes

pbmb metrics update

Change the fields you name and leave the rest. A change by a token moves a verified metric back to draft or agent_verified; check it again.

pbmb metrics update [OPTIONS] NAME

Argument	Required	What
name	yes

Option	Takes	Default	What
--label	str		Its name in words.
--definition	str		What the metric measures.
--aliases	str		Other names people search for, comma-separated, or none.
--when-to-use	str		When to use this metric rather than a similar one.
--not-the-same-as	str		How it differs from a metric it is mistaken for, or none.
--grain	str		The grain and the filters it applies.
--unit	str		Its unit, such as money or count.
--category	str		The category’s path, such as sales/orders.
--owner	str		Who answers for the metric.
--custom	str		A custom field, key=value; repeat it. A value is read as JSON when it is JSON (true, 3, [“a”]), else as text; write “42” for the text 42.

pbmb metrics verify

Mark a metric agent_verified. Refused while a check the conventions turn on fails; the sentence says which. A person approves it for human_verified: pbmb metrics request-review.

pbmb metrics verify NAME

Argument	Required	What
name	yes

pbmb queries

Search the query log and look at one logged query.

pbmb queries COMMAND

pbmb queries search

Search the log of queries, newest first.

Every signed-in user sees every entry: who ran it, when, the dataset, the DAX, the purpose and the row count, never the results. Use it to find DAX that already answers your question before you write new DAX.

pbmb queries search [OPTIONS] [WORDS]

Argument	Required	What
words	no

Option	Takes	Default	What
--dataset	str		Only this dataset.
--metric	str		Only queries that used this metric.
--mine			Only your own.
--status	str		succeeded, truncated, failed or refused.
--since	str		Only after this timestamp, such as 2026-10-01T00:00:00Z.

pbmb queries show

Show one logged query: its DAX, who ran it, how it ended and its result id.

pbmb queries show ID

Argument	Required	What
ID	yes

pbmb questions

Ask questions and leave comments on anything in the book.

pbmb questions COMMAND

pbmb questions accept

Accept a reply as the answer, which marks the question answered.

The person who asked can accept; so can a curator.

pbmb questions accept THREAD REPLY

Argument	Required	What
THREAD	yes
REPLY	yes

pbmb questions archive

Archive a thread. It leaves the default lists and search but is kept.

pbmb questions archive THREAD

Argument	Required	What
THREAD	yes

pbmb questions ask

Ask a question about an element, such as a metric or a column.

People who curate the book see it and can answer. The element’s get answers carry the accepted answers, so the next person finds them.

pbmb questions ask [OPTIONS] KIND ELEMENT_ID

Argument	Required	What
kind	yes
element_id	yes

Option	Takes	Default	What
--title	str		The question in one line.
--body	str		Plain text or Markdown.

pbmb questions comment

Leave a comment on an element. A comment has no title and takes replies.

pbmb questions comment [OPTIONS] KIND ELEMENT_ID

Argument	Required	What
kind	yes
element_id	yes

Option	Takes	Default	What
--body	str		Plain text or Markdown.

pbmb questions list

List questions and comments, newest first.

pbmb questions list [OPTIONS]

Option	Takes	Default	What
--mine			Only your own.
--status	str		open, answered or archived.
--element	str		Only about this element, written kind:id, such as metric:7c9e6679-7425-40de-944b-e07fc1f90ae7.

pbmb questions reply

Reply to a question or a comment.

pbmb questions reply [OPTIONS] THREAD

Argument	Required	What
THREAD	yes

Option	Takes	Default	What
--body	str		Plain text or Markdown.

pbmb questions show

Show a thread with its replies. Viewing it marks its replies as read.

pbmb questions show THREAD

Argument	Required	What
THREAD	yes

pbmb questions upvote

Upvote a question you want answered. You have one upvote per question.

pbmb questions upvote [OPTIONS] THREAD

Argument	Required	What
THREAD	yes

Option	Takes	Default	What
--remove			Take your upvote back.

pbmb results

Read the rows of a query result, or download them as CSV.

pbmb results COMMAND

pbmb results csv

Download a result you ran as a CSV file.

Asks for a signed link that works for 15 minutes and downloads from it to the file, which is written whole or not at all and readable by you only. Prints the path and the number of rows.

pbmb results csv [OPTIONS] ID

Argument	Required	What
ID	yes

Option	Takes	Default	What
-o, --output	file		The file to write.

pbmb results read

Read rows of a result you ran, a page at a time.

A result is readable only by the person or service account that ran its query. Results expire; the answer says when. A page that is not the last names the offset to ask for next.

pbmb results read [OPTIONS] ID

Argument	Required	What
ID	yes

Option	Takes	Default	What
--offset	int		Rows to skip.
--limit	int		Rows to read.

pbmb sa

Service accounts: named identities for scripts and agents, each with its own keys. Needs the admin role.

pbmb sa COMMAND

pbmb sa create

Create a service account. It has no key until you run sa keys create.

pbmb sa create [OPTIONS] NAME

Argument	Required	What
name	yes

Option	Takes	Default	What
--owner	str		The email address of the person answerable for it.
--role	str		A role it holds. Repeat for more than one.
--workspace	str		Limit it to this workspace id. Repeat for more.
--app	str		Limit it to this app id. Repeat for more.
--max-key-age-days	int		The longest any of its keys may live, in days.

pbmb sa delete

Delete a service account and its keys.

pbmb sa delete NAME

Argument	Required	What
name	yes

pbmb sa disable

Disable a service account. Its keys stop working at once.

pbmb sa disable NAME

Argument	Required	What
name	yes

pbmb sa keys

A service account’s API keys.

pbmb sa keys COMMAND

pbmb sa keys create

Create an API key for a service account.

The key is printed once and cannot be shown again; the api keeps only a digest. Run this yourself and put the key where the script reads it, such as PBMB_API_KEY. Never paste it into a chat.

pbmb sa keys create [OPTIONS] NAME

Argument	Required	What
name	yes

Option	Takes	Default	What
--expires-in-days	int		Days until the key expires. Default: the account’s longest allowed key age.

pbmb sa keys list

List a service account’s keys: when each was made, expires and was last used.

The keys themselves are never shown, only their first characters.

pbmb sa keys list NAME

Argument	Required	What
name	yes

pbmb sa keys revoke

Revoke a key. It stops working at once.

pbmb sa keys revoke NAME KEY_ID

Argument	Required	What
name	yes
KEY_ID	yes

pbmb sa list

List the service accounts.

pbmb sa list

pbmb search

Search the book by meaning and by words, for metrics, columns and more.

Example: pbmb search net revenue –kind metric –trust-state human_verified

Answers the closest matches first, each with where it lives and how far it is verified. Searches only what you may describe.

pbmb search [OPTIONS] WORDS

Argument	Required	What
words	yes

Option	Takes	Default	What
--kind	str		Only these kinds: metric, variant, column, term, dataset, table or category. Repeat, or separate with commas.
--workspace	str		Only inside this workspace (id or name).
--app	str		Only inside this app (id or name).
--dataset	str		Only inside this dataset (id or name).
--category	str		Only inside this category path.
--trust-state	str		Only these: draft, agent_verified or human_verified. Repeat, or separate with commas.
--unit	str		Only metrics in this unit.
--custom	str		A custom field, key=value; repeat it. A value is read as JSON when it is JSON (true, 3, [“a”]), else as text; write “42” for the text 42.
--limit	int		At most this many.

pbmb sync

Start a sync of the Power BI tenant and see how the last ones went.

pbmb sync COMMAND

pbmb sync run

Queue a sync now, unless one is already waiting or running.

The sync reads the tenant’s workspaces, datasets and measures. By default it reads only what changed since the last one. See how it goes with pbmb sync status.

pbmb sync run [OPTIONS]

Option	Takes	Default	What
--full			Read every workspace again, not only what changed.

pbmb sync status

Show the newest sync runs, how each ended and how many workspaces it read.

pbmb sync status

pbmb terms

The glossary: terms, the columns behind them and their values, and the metrics they relate to.

pbmb terms COMMAND

pbmb terms create

Create a term. Link columns to it with pbmb terms link.

pbmb terms create [OPTIONS] NAME

Argument	Required	What
name	yes

Option	Takes	Default	What
--definition	str		What the term means.
--aliases	str		Other names, comma-separated, or none.
--not-the-same-as	str		What it is mistaken for, or none.
--values	str		The values a dimension term takes, comma-separated, or none.
--owner	str		Who answers for the term.
--custom	str		A custom field, key=value; repeat it. A value is read as JSON when it is JSON (true, 3, [“a”]), else as text; write “42” for the text 42.

pbmb terms delete

Delete a term.

pbmb terms delete NAME

Argument	Required	What
name	yes

pbmb terms link

Make a column back the term, so the term’s values are that column’s.

pbmb terms link NAME COLUMN_ID

Argument	Required	What
name	yes
column_id	yes

pbmb terms list

List terms A to Z. A dimension term is backed by columns; a concept is not.

pbmb terms list [OPTIONS]

Option	Takes	Default	What
--dataset	str		Only terms backed by a column in this dataset.
--workspace	str		Only terms backed by a column in this workspace.
--app	str		Only terms backed by a column in this app.
--trust-state	str		Only this trust state; repeat for several.
--custom	str		Only terms whose custom field matches, key=value.
--limit	int		At most this many.
--cursor	str		The cursor the last page ended with.

pbmb terms relate

Relate the term to a metric, so the metric lists it among its terms.

Example: pbmb terms relate Order number_of_orders

pbmb terms relate NAME METRIC

Argument	Required	What
name	yes
metric	yes

pbmb terms show

Show a term: definition, values, the columns behind it and related metrics.

pbmb terms show NAME

Argument	Required	What
name	yes

pbmb terms unlink

Stop a column backing the term.

pbmb terms unlink NAME COLUMN_ID

Argument	Required	What
name	yes
column_id	yes

pbmb terms unrelate

Stop relating the term to a metric.

Example: pbmb terms unrelate Order number_of_orders

pbmb terms unrelate NAME METRIC

Argument	Required	What
name	yes
metric	yes

pbmb terms update

Change the fields you name and leave the rest.

pbmb terms update [OPTIONS] NAME

Argument	Required	What
name	yes

Option	Takes	Default	What
--name	str		Rename it.
--definition	str		What the term means.
--aliases	str		Other names, comma-separated, or none.
--not-the-same-as	str		What it is mistaken for, or none.
--values	str		The values a dimension term takes, comma-separated, or none.
--owner	str		Who answers for the term.
--custom	str		A custom field, key=value; repeat it. A value is read as JSON when it is JSON (true, 3, [“a”]), else as text; write “42” for the text 42.

pbmb variants

One measure in one dataset: its DAX and its shift.

pbmb variants COMMAND

pbmb variants move

Move a variant under another metric, and set how it is shifted from it.

A variant is the metric’s calculation shifted on currency, period or comparison only; a different calculation is a different metric.

pbmb variants move [OPTIONS] ID

Argument	Required	What
ID	yes

Option	Takes	Default	What
--to	str		The metric that should own the variant.
--period	str		Its period, such as previous_year.
--comparison	str		none, difference, growth_rate or ratio.
--comparison-period	str		The period it is compared with.
--currency	str		Its currency code.
--axis	str		A custom axis, key=value; repeat it.
--note	str		Why it is shifted.

pbmb variants show

Show a variant: its metric, dataset, measure_reference, shift and DAX.

Use this DAX against its dataset instead of writing your own.

pbmb variants show ID

Argument	Required	What
ID	yes

pbmb whoami

Show who the deployment sees you as.

Asks GET /api/v1/me: the person or service account, its roles and the state of the Power BI connection, and on the sample tenant a line saying so. It proves the address, your credentials and the api in one call, so it is the first thing to run after pbmb login.

pbmb whoami

pbmb workspaces

The Power BI workspaces you can see.

pbmb workspaces COMMAND

pbmb workspaces list

List the workspaces you can see, with how many datasets each holds.

Example: pbmb workspaces list

pbmb workspaces list