Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion _docs/v0.62/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,8 @@ Metabase's reference documentation.
- [Development instances](./installation-and-operation/development-instance)
- [Serialization](./installation-and-operation/serialization)
- [Remote sync](./installation-and-operation/remote-sync)
- [Commands](./installation-and-operation/commands)
- [Metabase CLI](./installation-and-operation/metabase-cli)
- [Metabase JAR commands](./installation-and-operation/commands)
- [Supported browsers](./installation-and-operation/supported-browsers)
- [Privacy](./installation-and-operation/privacy)
- [About the anonymous usage data we collect](./installation-and-operation/information-collection)
Expand Down
301 changes: 60 additions & 241 deletions _docs/v0.62/ai/file-based-development.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion _docs/v0.62/ai/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ See [full docs for MCP server](mcp).

**Best for: developers creating stuff that other people will use.**

Use a coding agent like Claude Code to understand your database's metadata, generate Metabase content as YAML files locally, verify the schema, then sync and import the generated content into your production Metabase. Sky's the limit on what you can accomplish.
Use a coding agent like Claude Code with the Metabase CLI to create Metabase content directly in a development instance, then version that content as YAML files and pull the changes into your production Metabase.

**Controls**: Only admins can sync content to Metabase instances.

Expand Down
2 changes: 1 addition & 1 deletion _docs/v0.62/configuring-metabase/appearance.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ What people see when Metabase prompts them to log in.

### Landing page

The landing page is what people will see whenever they login. You can set the URL to a collection, question, dashboard or whatever, just make sure that everyone has access to that URL.
The illustration people see on the landing page when they log in. To choose which page people land on, see [Homepage](./settings#homepage).

- Lighthouse
- No illustration
Expand Down
8 changes: 5 additions & 3 deletions _docs/v0.62/configuring-metabase/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,13 @@ For example, say you enable HTTPS redirect for a Metabase instance at the site U

> Note: if you haven't set up HTTPS on your server, Metabase will not let you enable HTTPS redirect. Instead, you'll get a warning saying "It looks like HTTPS is not properly configured."

## Custom homepage
## Homepage

Admins can pick a dashboard to serve as the homepage. If people lack permissions to view the selected dashboard, Metabase will redirect them to the default homepage.
Set the page people see when they first log in to your Metabase. Choose between:

To revert to the default Metabase homepage, simply toggle off Custom homepage.
- **Default Metabase home**: The standard Metabase homepage.
- **Dashboard**: Pick a dashboard to serve as the homepage. If people lack permissions to view the selected dashboard, Metabase will redirect them to the default homepage.
- **Custom URL**: Send people to a specific URL (a collection, question, dashboard, or other page). Make sure people have access to the URL. This option is only available on Metabase [Pro](/product/pro) and [Enterprise](/product/enterprise) plans.

## Email address for help requests

Expand Down
4 changes: 2 additions & 2 deletions _docs/v0.62/data-studio/transforms/addons.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ With basic transforms, you can:

- **Metabase Cloud**: Basic transform functionality on Metabase Cloud - Starter, Pro, or Enterprise - comes with an additional small fee per successful transform run, see [Pricing](/pricing).

Only people logged in with an email of a [Metabase Store admins](../../cloud/accounts-and-billing#add-people-to-manage-your-metabase-store-account) (not just Metabase _instance_ admins) can enable basic transforms. To enable Basic transforms on Metabase Cloud, see [Enable transforms](./transforms-overview#enable-transforms).
Only people logged in with an email of a [Metabase Store admin](../../cloud/accounts-and-billing#add-managers) (not just Metabase _instance_ admins) can [enable basic transforms](./transforms-overview#enable-transforms).

### Cancel basic transforms

Expand Down Expand Up @@ -76,7 +76,7 @@ There are two ways to enable Advanced transforms:

- **From your Metabase instance**: you can navigate to a feature requiring advanced transforms (like Python transforms or transform inspector), and follow the prompts to upgrade.

To enable Advanced transforms from your Metabase instance, you need to be logged into the instance with the same email as a [Metabase Store admin](../../cloud/accounts-and-billing#add-people-to-manage-your-metabase-store-account), because Advanced transform incur an additional charge.
To enable Advanced transforms from your Metabase instance, you need to be logged into the instance with the same email as a [Metabase Store admin](../../cloud/accounts-and-billing#add-managers), because Advanced transform incur an additional charge.

- **From [Metabase Store](https://store.metabase.com)**:

Expand Down
2 changes: 1 addition & 1 deletion _docs/v0.62/data-studio/transforms/transforms-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Permission configuration for transform depends on your plan.

Before you can start writing transforms, you'll need to enable transforms in your Metabase instance.

If you are on a Metabase Cloud plan, only people logged in with an email of a [Metabase Store admins](../../cloud/accounts-and-billing#add-people-to-manage-your-metabase-store-account) (not just Metabase _instance_ admins) can enable basic transforms, because transforms incur a cost per run on Metabase Cloud.
If you're on a Metabase Cloud plan, only people logged in with an email of a [Metabase Store admin](../../cloud/accounts-and-billing#add-managers) (not just Metabase _instance_ admins) can enable basic transforms, because transforms incur a cost per run on Metabase Cloud.

To enable transforms:

Expand Down
2 changes: 1 addition & 1 deletion _docs/v0.62/exploration-and-organization/x-rays.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,4 +71,4 @@ If for some reason X-rays aren't a good fit for your team or your data, administ

If you pin any dashboards in the "Our Analytics" collection, Metabase will hide the X-ray suggestions that appear on the homepage.

Admins can also manually remove these suggestions by clicking on the **Customize** button in the upper right and selecting a dashboard as your homepage. [Changing the home page](../configuring-metabase/settings#custom-homepage) won't disable the X-ray features in the rest of Metabase.
Admins can also manually remove these suggestions by clicking on the **Customize** button in the upper right and selecting a dashboard as your homepage. [Changing the home page](../configuring-metabase/settings#homepage) won't disable the X-ray features in the rest of Metabase.
11 changes: 6 additions & 5 deletions _docs/v0.62/installation-and-operation/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,17 @@ has_magic_breadcrumbs: true
show_category_breadcrumb: true
show_title_breadcrumb: true
category: 'Installation and Operation'
title: 'Metabase CLI'
title: 'Metabase JAR commands'
source_url: 'https://github.com/metabase/metabase/blob/master/docs/installation-and-operation/commands.md'
layout: new-docs
description: 'CLI commands for managing your Metabase instance, including database migrations, serialization, and administrative tasks.'
description: 'Commands built into the Metabase JAR for managing your instance, including database migrations, serialization, and administrative tasks.'
---

# Metabase CLI
# Metabase JAR commands

Metabase ships with some handy CLI commands for administration, maintenance, and automation tasks. These commands let you manage your Metabase instance, migrate databases, handle serialization, and generate documentation.
> Looking for the `mb` command-line client that drives a Metabase instance over its API, on its own or through an AI agent? Check out the [Metabase CLI](./metabase-cli).

Metabase ships with some handy commands for administration, maintenance, and automation tasks. These commands run on the server, built into the Metabase JAR, and let you manage your Metabase instance, migrate databases, handle serialization, and generate documentation.

To view a list of commands, run the Metabase jar followed by `help`.

Expand All @@ -22,7 +24,6 @@ java --add-opens java.base/java.nio=ALL-UNNAMED -jar metabase.jar help

Metabase will print out the help text for available commands.


## `api-documentation`

Generate an HTML file and a JSON file for Scalar docs for the Metabase API.
Expand Down
84 changes: 84 additions & 0 deletions _docs/v0.62/installation-and-operation/metabase-cli.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
---
version: v0.62
has_magic_breadcrumbs: true
show_category_breadcrumb: true
show_title_breadcrumb: true
category: 'Installation and Operation'
title: 'Metabase CLI'
source_url: 'https://github.com/metabase/metabase/blob/master/docs/installation-and-operation/metabase-cli.md'
layout: new-docs
summary: 'The Metabase CLI (mb) is a command-line client that drives a Metabase instance over its API. Use it yourself, or hand it to an AI agent with the metabase-cli skill.'
---

# Metabase CLI

The Metabase CLI (`mb`) is a command-line client for Metabase. `mb` authenticates against a Metabase instance with an API key and lets you or an AI agent read and write content like questions, dashboards, collections, and transforms over the Metabase API.

> Looking for the commands built into the Metabase JAR, like `migrate` or `load-from-h2`? Check out [Metabase JAR commands](./commands).

## Requirements

- Node.js, to install the CLI from npm.
- A Metabase instance on version 58 or later.
- An [API key](../people-and-groups/api-keys#create-an-api-key) to authenticate the CLI against your instance.
- A Pro or Enterprise plan for some command groups. For example, `git-sync` needs the premium [Remote sync](./remote-sync) feature.

## Install the CLI

```
npm install -g @metabase/cli
```

The binary is `mb`.

For commands, run:

```
mb --help
```

## Authenticate the CLI

Log in once per Metabase instance.

```
mb auth login --url https://metabase.example.com
```

The CLI prompts for an API key, or reads it from the `METABASE_API_KEY` environment variable or stdin. To create a key, see [API keys](../people-and-groups/api-keys#create-an-api-key).

Credentials are stored per profile, so you can manage more than one Metabase (like dev and prod Metabases):

```
mb auth login --profile prod --url https://prod.example.com
mb auth list
```

Add `--profile <name>` to any command to run it against that instance.

## Use the CLI with an AI agent

The CLI is built to be driven by an AI coding agent like Claude Code. Instead of running commands yourself, you install a skill and describe what you want in plain language; the agent works out the commands.

### The metabase-cli skill

The [metabase-cli skill](https://github.com/metabase/agent-skills/tree/main/skills/metabase-cli) teaches your agent the CLI's conventions. Once installed, you can run:

```
/metabase-cli Create a dashboard summarizing this month's signups by plan.
```

And your agent will go to work, creating content directly in your Metabase via the `mb` CLI.

## Use the CLI for agent-driven development

Pair the CLI with version control to build content with an agent in a development Metabase, commit the changes, and pull the changes into your production Metabase. Check out [Agent-driven development](../ai/file-based-development).

## Further reading

- [@metabase/cli on npm](https://www.npmjs.com/package/@metabase/cli)
- [Agent-driven development](../ai/file-based-development)
- [Agent skills](https://github.com/metabase/agent-skills)
- [Remote sync](./remote-sync)
- [Serialization](./serialization)
- [Metabase JAR commands](./commands)
8 changes: 6 additions & 2 deletions _docs/v0.62/installation-and-operation/start.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,10 @@ Try out your changes before deploying to production.

Export your questions, dashboards, and more as YAML files that you can check into version control.

## [Metabase CLI](./metabase-cli)

A command-line client that drives a Metabase instance over its API, on its own or through an AI agent.

## [Monitoring your Metabase](./monitoring-metabase)

Monitor your Metabase with JMX.
Expand All @@ -61,9 +65,9 @@ We collect anonymous Metabase usage data to improve the product. We don't collec

Notes on Metabase's accessibility.

## [Command line commands](./commands)
## [Metabase JAR commands](./commands)

Metabase's CLI.
Administrative commands built into the Metabase JAR.

---

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading