@metabase/cli 0.5.4 → 0.5.6

package/skill-data/git-sync/SKILL.md

@@ -7,7 +7,7 @@ requires: [remoteSync]
 
 # git-sync (representations ↔ instance)
 
-Metabase content (cards, dashboards, transforms, snippets, collections, …) can live in a git repo as YAML and round-trip in and out of a Metabase instance via the `git-sync` verbs. The instance is configured with a `remote-sync-*` settings block (URL, branch, token, type read-only/read-write); the CLI drives the sync tasks against `/api/ee/remote-sync/*`. Only collections flagged for sync serialize; everything else is local-only. Table and field metadata round-trips too, for Library-published tables in a flagged collection — see "Published table metadata" below.
+Metabase content (cards, dashboards, transforms, snippets, collections, …) can live in a git repo as YAML and round-trip in and out of a Metabase instance via the `git-sync` verbs. The instance is configured with a `remote-sync-*` settings block (URL, branch, token, type read-only/read-write); the CLI drives the sync tasks against `/api/ee/remote-sync/*`. Only flagged collections serialize, plus, unflagged: each data app's collection (with its app, `data_apps/<slug>/`), transforms (`remote-sync-transforms`), and snippets, data actions and glossary once the Library is synced. Everything else is local-only. Table and field metadata round-trips too, for Library-published tables in a flagged collection — see "Published table metadata" below.
 
 The repo and the instance are two ends of the same state; what "push my changes" means depends on where the changes were made. If they were made **in the instance** (CLI verbs against a read-write instance — cards edited, transforms created, tables published, metadata written), "push my changes" / "save this to the repo" / "open a PR with these changes" means driving the instance's export to a branch (`stash` or `create-branch` + `export`) and opening the PR from that branch — not reconstructing the changes as files. If the workflow is **repo-first** (content YAML edited in the repo, the instance imports it), plain `git` against the repo is the way — but only in the serialized layout already there: files in paths or formats the serializer doesn't own are invisible to Metabase and never apply on import.
 
@@ -64,7 +64,7 @@ Workflow:
 
 <!-- requires: remoteSyncRemoteChanges -->
 
-Between the two, confirm `has-remote-changes` reports `has_changes: true` — there's actually something to import.
+Between the two, confirm `has-remote-changes` reports `has_changes: true` (`--force-refresh` after your own push: the answer is cached).
 
 <!-- /requires -->
 
@@ -168,7 +168,7 @@ Skip the prompt only if the user's instructions already specified the branch (e.
 ```bash
 mb git-sync branches --profile <n> --json                 # list remote branches
 mb git-sync create-branch <name> --profile <n>            # create + switch sync to it
-mb git-sync stash --profile <n>                           # export current state to a NEW branch
+mb git-sync stash --new-branch <name> --profile <n>       # export current state to a NEW branch
 ```
 
 `stash` is the safe move when the instance has team work you don't want to lose, but you need to pivot to a different branch (`import` would discard, `export --force` would overwrite). It exports current state to a fresh branch first.
@@ -184,19 +184,21 @@ Use `wait` after `import --no-wait` / `export --no-wait`. Use `cancel-task` if a
 
 ## Adding / removing a directory (collection) to sync
 
-The set of directories under sync is governed by which **collections** carry `is_remote_synced: true`. Every collection so flagged serializes to its own folder under `collections/` in the repo; everything outside that set is local-only. The CLI exposes per-collection toggles that route to the underlying bulk endpoint (`PUT /api/ee/remote-sync/settings`):
+The set of directories under sync is governed by which **collections** carry `is_remote_synced: true`. Every collection so flagged serializes to its own folder under `collections/` in the repo; so do the unflagged ones above (a data app's collection can't be flagged). Everything else is local-only. Toggle one collection at a time:
 
 ```bash
 mb git-sync add-collection    <collection-id> --profile <n> --json
 mb git-sync remove-collection <collection-id> --profile <n> --json
 ```
 
-`<collection-id>` is a **positive integer** (the bulk endpoint's schema is `pos-int? → boolean`; nano-id / `root` / `trash` refs are not supported). Get the id from `collection list` (see `core`).
+`<collection-id>` is a **positive integer** (no nano-id, `root` or `trash`). Get the id from `collection list` (see `core`).
 
-Both verbs return `{ success: true }`, plus a `task_id` only when the toggle started a follow-up task (e.g. a finalization import after switching to read-only).
+Both return `{ success: true }`, plus a `task_id` when the toggle started a follow-up task.
 
 **Cascade.** A toggle on a parent cascades to every descendant by `location` prefix — `add-collection 4` flips `4` plus every collection nested under it. `remove-collection 4` is the symmetric inverse. There is no per-leaf-only mode.
 
+**Custom collections.** Outside the Library, transforms, snippets and data actions, a flag answers 400 unless the admin setting `remote-sync-custom-collections-enabled` is on (a data app's collection can't be flagged at all).
+
 **Mode prerequisite.** The server rejects toggles while `remote-sync-type` is `:read-only` (the install default; `mb git-sync status --json` reports it as `sync_type`). If `mb git-sync add-collection 12` returns `Metabase returned 400 … Cannot change synced collections when remote-sync-type is read-only.`, switch first with:
 
 ```bash
@@ -237,13 +239,13 @@ To plan the order before the first move, `mb dependency graph dashboard <id> --j
 
 ## Published table metadata (Library) and sync scope
 
-Table and field metadata — table/field descriptions, semantic types (`type/PK`, `type/FK`), FK targets, plus segments and measures on the table — serializes for **Library-published tables only**, under `databases/<db>/schemas/<schema>/tables/<table>/…` in the repo. Eligibility is two-gated: the table must be published (`mb library publish`), **and** the Library collection holding it must itself carry `is_remote_synced: true`. An ordinary warehouse table, or a transform's target table that isn't published, never serializes — a transform's YAML carries only the transform definition (query, target, description), not the output table's field metadata.
+Table and field metadata — table/field descriptions, semantic types (`type/PK`, `type/FK`), FK targets, plus segments and measures on the table — serializes for **Library-published tables only**, under `databases/<db>/schemas/<schema>/tables/<table>/…` in the repo. Eligibility is two-gated: the table must be published (`mb library publish`), **and** Library Data must be synced; flag the Library root, as Data alone leaves out Metrics, Dashboards, snippets, data actions and glossary. An ordinary warehouse table, or a transform's target table that isn't published, never serializes — a transform's YAML carries only the transform definition (query, target, description), not the output table's field metadata.
 
-The classic trap: publish tables, write field metadata, then `git-sync dirty` comes back empty and nothing lands in the repo. That does not mean git-sync can't carry table metadata — it means the Library collection isn't in the sync scope, so nothing was eligible for dirty-tracking when the writes happened. Check the scope (`synced_collections` in `status`), then:
+The classic trap: publish tables, write field metadata, then `git-sync dirty` comes back empty and nothing lands in the repo. It means the Library collection isn't in the sync scope, so nothing was eligible for dirty-tracking when the writes happened. Check the scope (`synced_collections` in `status`), then:
 
 ```bash
-mb library get --profile <n> --json                                # Library Data collection id
-mb git-sync add-collection <library-data-id> --profile <n>
+mb collection list --profile <n> --json                            # the "type": "library" entry's id
+mb git-sync add-collection <library-id> --profile <n>
 mb git-sync stash --new-branch <branch> -m "..." --profile <n>     # or create-branch + export
 ```
 
@@ -256,7 +258,7 @@ Flagging the collection records it for the next export, which serializes its cur
 - Don't turn instance-side changes into hand-written repo files: export them and PR the exported branch (see the top of this skill). Files pushed behind Metabase's back race its own sync tasks.
 - Don't conclude from an empty `dirty` list that a change type isn't tracked. Dirty-tracking only records changes to _eligible_ objects; the usual cause is scope (the collection isn't flagged — see "Published table metadata"), not capability. Check `synced_collections` in `status` before concluding.
 - Don't run `git-sync import --force` or `git-sync export --force` without explicit user confirmation. Both are lossy — `--force` import discards instance-side work, `--force` export overwrites the remote branch.
-- Don't drive `git-sync` against a Metabase instance that doesn't have remote-sync configured — every verb returns an error pointing at the missing `remote-sync-*` settings. To check: `mb git-sync status --profile <n> --json` reports `remote_configured: false` when no remote is configured.
+- Don't drive `git-sync` against a Metabase instance that doesn't have remote-sync configured — import, export, has-remote-changes and export-preflight answer `Remote sync is not configured.` To check: `mb git-sync status --profile <n> --json` succeeds and reports `remote_configured: false`.
 - Don't author content directly via `card create` / `transform create` and then assume `git-sync export` will commit it cleanly — the instance and repo can drift if you mix direct API writes with sync-tracked changes. If you do, follow direct writes immediately with `git-sync export -m "..."` to keep them in step.
 - Don't move a dashboard or question into a synced collection before what it depends on, and don't retry a `Uses content that is not remote synced.` refusal unchanged. Move the listed dependencies first, move the whole containing collection, or build the content in the synced collection to begin with (see "Moving content into or out of a synced collection").
 - Don't omit `-m` on `export` if the user wants a meaningful commit message — the default server-generated message is generic.

package/skill-data/mbql/SKILL.md

@@ -49,7 +49,7 @@ An options key the server doesn't know is rejected or silently dropped, never ap
 - `filters` are ANDed; OR is `["or", {}, a, b, …]`. Multi-value is `["in", {}, <field>, "a", "b"]` / `["not-in", …]`.
 - Relative dates: `["time-interval", {}, <field>, -30, "day"]`, `["time-interval", {}, <field>, "current", "month"]`. A stated year or date range is absolute: `["between", {}, <field>, "2024-01-01", "2024-12-31"]` (inclusive).
 - `aggregation` is a list of aggregation clauses, `breakout` a list of refs. "only / where X" is a filter; "by / per / over time" is a breakout.
-- Name every aggregation a later stage, a chart setting or a target table reads: `["sum", {"name": "revenue", "display-name": "Revenue"}, <field>]`. Unnamed, it is `count`, `sum`, `avg`, … and a second `sum` is `sum_2`.
+- An unnamed aggregation is `count`, `sum`, `avg`, …, a breakout keeps its field's name, and a repeat gets a suffix that moves when clauses change: a second `sum` is `sum_2`, a second `ID` breakout (another table's) `ID_2`. When a later stage, a chart setting or a target table reads such a column, set `"name"` in the clause's options: `["sum", {"name": "revenue", "display-name": "Revenue"}, <field>]`, `["field", {"name": "product_id", "source-field": 11}, 12]`.
 - An aggregation can be arithmetic over aggregations: `["/", {"name": "aov"}, ["sum", {}, <field>], ["count", {}]]`.
 - Date arithmetic is `["datetime-diff", {}, a, b, "day"]`.
 
@@ -122,7 +122,7 @@ A later stage reads the previous stage's output by column name, with the column'
 ]
 ```
 
-The names and base types are the `name` and `base_type` of the columns the earlier stages return: run them once (`mb query … --json`, `data.cols`) and copy both. A breakout keeps its field's name (`CREATED_AT`, even when bucketed); an aggregation has the `name` you gave it.
+The names and base types are the `name` and `base_type` of the columns the earlier stages return: run them once (`mb query … --json`, `data.cols`) and copy both. A breakout keeps its field's name (`CREATED_AT`, even when bucketed) and an aggregation its operator's, unless its options set `name`.
 
 **Window:** `offset` sits in `aggregation` and reads another breakout row. Month-over-month against a monthly breakout:
 

package/dist/git-sync-Czena0TW.mjs

@@ -1,29 +0,0 @@
-import { t as defineCommandGroup } from "./group--6adAsqG.mjs";
-//#region src/commands/git-sync/index.ts
-var git_sync_default = defineCommandGroup({
-	name: "git-sync",
-	description: "Sync Metabase content with a git remote",
-	skills: [{
-		skill: "git-sync",
-		purpose: "import/export round-trip and dirty checks"
-	}],
-	subCommands: {
-		status: () => import("./status-BezD_K-g.mjs").then((mod) => mod.default),
-		"is-dirty": () => import("./is-dirty-haRLODo1.mjs").then((mod) => mod.default),
-		"has-remote-changes": () => import("./has-remote-changes-DZq7q2Wk.mjs").then((mod) => mod.default),
-		dirty: () => import("./dirty-BHwdHOEj.mjs").then((mod) => mod.default),
-		"current-task": () => import("./current-task-DhgwtGN3.mjs").then((mod) => mod.default),
-		"cancel-task": () => import("./cancel-task-BuZsQuLp.mjs").then((mod) => mod.default),
-		wait: () => import("./wait-DEYagfq4.mjs").then((mod) => mod.default),
-		import: () => import("./import-DKZF0kMU.mjs").then((mod) => mod.default),
-		export: () => import("./export-BNj3RvAl.mjs").then((mod) => mod.default),
-		"export-preflight": () => import("./export-preflight-F3OapAD5.mjs").then((mod) => mod.default),
-		stash: () => import("./stash-leoW1fby.mjs").then((mod) => mod.default),
-		branches: () => import("./branches-CERgKqFq.mjs").then((mod) => mod.default),
-		"create-branch": () => import("./create-branch-D_nbKxDS.mjs").then((mod) => mod.default),
-		"add-collection": () => import("./add-collection-D2x34KVO.mjs").then((mod) => mod.default),
-		"remove-collection": () => import("./remove-collection-Qne5ww6M.mjs").then((mod) => mod.default)
-	}
-});
-//#endregion
-export { git_sync_default as default };

package/dist/signal-BNUlQjpc.mjs

@@ -1,25 +0,0 @@
-import { g as errorMessage, i as AbortError, l as MetabaseError } from "./predicates-0C0TsWcJ.mjs";
-//#region ../client/src/signal.ts
-function combineAborts(...signals) {
-	return AbortSignal.any(signals.filter((signal) => signal !== void 0));
-}
-function throwIfAborted(...signals) {
-	for (const signal of signals) if (signal?.aborted) throw abortReason(signal);
-}
-function abortReason(signal) {
-	const reason = signal.reason;
-	if (reason instanceof MetabaseError) return reason;
-	if (reason instanceof Error || typeof reason === "string") return new AbortError(errorMessage(reason) || "aborted");
-	return new AbortError("aborted");
-}
-function untilAborted(promise, signal) {
-	if (signal === void 0) return promise;
-	throwIfAborted(signal);
-	return new Promise((resolve, reject) => {
-		const onAbort = () => reject(abortReason(signal));
-		signal.addEventListener("abort", onAbort, { once: true });
-		promise.then(resolve, reject).finally(() => signal.removeEventListener("abort", onAbort));
-	});
-}
-//#endregion
-export { throwIfAborted as n, untilAborted as r, combineAborts as t };

package/dist/table-Dzp1uANs.mjs

@@ -1,26 +0,0 @@
-import { t as defineCommandGroup } from "./group--6adAsqG.mjs";
-//#region src/commands/table/index.ts
-var table_default = defineCommandGroup({
-	name: "table",
-	description: "Manage Metabase tables",
-	skills: [{
-		skill: "metadata",
-		purpose: "table and column metadata, semantic types, visibility"
-	}],
-	subCommands: {
-		list: () => import("./list-P7FnSsbZ.mjs").then((m) => m.default),
-		get: () => import("./get-uHs9Ve-4.mjs").then((m) => m.default),
-		fields: () => import("./fields-BkAS_wIA.mjs").then((m) => m.default),
-		fks: () => import("./fks--SaqvPw1.mjs").then((m) => m.default),
-		update: () => import("./update-Zv7PP8nl.mjs").then((m) => m.default),
-		"sync-schema": () => import("./sync-schema-BtjC-PNY.mjs").then((m) => m.default),
-		"rescan-values": () => import("./rescan-values-COzM86P5.mjs").then((m) => m.default),
-		"discard-values": () => import("./discard-values-BWlh2ce8.mjs").then((m) => m.default),
-		"bulk-edit": () => import("./bulk-edit-CJxoxDGQ.mjs").then((m) => m.default),
-		"bulk-sync-schema": () => import("./bulk-sync-schema-CBIs4yHs.mjs").then((m) => m.default),
-		"bulk-rescan-values": () => import("./bulk-rescan-values-DflzyxEj.mjs").then((m) => m.default),
-		"bulk-discard-values": () => import("./bulk-discard-values-BQ3z6nJb.mjs").then((m) => m.default)
-	}
-});
-//#endregion
-export { table_default as default };

package/dist/transform-C-0nV5Et.mjs

@@ -1,28 +0,0 @@
-import { t as defineCommandGroup } from "./group--6adAsqG.mjs";
-//#region src/commands/transform/index.ts
-var transform_default = defineCommandGroup({
-	name: "transform",
-	description: "Manage Metabase transforms",
-	skills: [{
-		skill: "transform",
-		purpose: "body shape, run-with-wait, iterate"
-	}, {
-		skill: "mbql",
-		purpose: "MBQL source.query bodies"
-	}],
-	subCommands: {
-		list: () => import("./list-BiIZdUoN.mjs").then((mod) => mod.default),
-		get: () => import("./get-BjgB5l7X.mjs").then((mod) => mod.default),
-		dependencies: () => import("./dependencies-D6SNdLW8.mjs").then((mod) => mod.default),
-		create: () => import("./create-DEIIUohY2.mjs").then((mod) => mod.default),
-		update: () => import("./update-CEDMvgJI.mjs").then((mod) => mod.default),
-		delete: () => import("./delete-ZjLpkwgx.mjs").then((mod) => mod.default),
-		"delete-table": () => import("./delete-table-CnGv1gx9.mjs").then((mod) => mod.default),
-		run: () => import("./run-JYNbEO_V.mjs").then((mod) => mod.default),
-		cancel: () => import("./cancel-CyTRWSOr.mjs").then((mod) => mod.default),
-		"get-run": () => import("./get-run-CHup8cMl.mjs").then((mod) => mod.default),
-		runs: () => import("./runs-GQD6FO2k.mjs").then((mod) => mod.default)
-	}
-});
-//#endregion
-export { transform_default as default };

package/dist/transform-job-B9MPk7S5.mjs

@@ -1,22 +0,0 @@
-import { t as defineCommandGroup } from "./group--6adAsqG.mjs";
-//#region src/commands/transform-job/index.ts
-var transform_job_default = defineCommandGroup({
-	name: "transform-job",
-	description: "Manage Metabase transform jobs",
-	skills: [{
-		skill: "transform",
-		purpose: "tag-driven job schedules"
-	}],
-	subCommands: {
-		list: () => import("./list-OUSeeuXb.mjs").then((mod) => mod.default),
-		get: () => import("./get-gGSl7Se4.mjs").then((mod) => mod.default),
-		create: () => import("./create-XVjr8IDS.mjs").then((mod) => mod.default),
-		update: () => import("./update-7iXRB23T2.mjs").then((mod) => mod.default),
-		delete: () => import("./delete-CuyGTe0i.mjs").then((mod) => mod.default),
-		run: () => import("./run-Bwj4Uuxk.mjs").then((mod) => mod.default),
-		transforms: () => import("./transforms-DcXL4Dox.mjs").then((mod) => mod.default),
-		"set-active": () => import("./set-active-CWDdv3kN.mjs").then((mod) => mod.default)
-	}
-});
-//#endregion
-export { transform_job_default as default };