Mintlify CLI command reference

Global flags

These flags are available on all commands.

mint dev

Start a local preview of your documentation.

mint dev [flags]

mint signup

Create a new Mintlify account from the terminal.

mint signup [flags]

Run the command without flags to enter your details interactively. The CLI prompts for any value you do not pass as a flag.

After you submit your details, Mintlify sends a verification link to your email. The command waits until you click the link, then creates your account, logs you in, and stores your credentials. When it finishes, open the dashboard to connect your repository and start building.

Examples

# Sign up interactively
mint signup

# Sign up with all details provided
mint signup \
  --firstName Jane \
  --lastName Doe \
  --company Acme \
  --email jane@acme.com

mint login

Authenticate with your Mintlify account.

mint login

Opens a browser window to complete authentication. If the browser does not open, the CLI displays a URL to open manually and a prompt to paste the authorization code. Credentials save in ~/.config/mintlify/config.json.

If you have more than one deployment, the CLI prompts you to select a default after you log in. You can change the default project later with mint config set subdomain <subdomain>.

mint logout

Remove stored credentials.

mint logout

mint status

Display your current session details including CLI version, account email, organization, and configured subdomain.

mint status

mint add-domain

Add a custom domain to your deployment from the terminal. Requires authentication with mint login.

mint add-domain <domain> [--basePath <path>]

The command uses your configured subdomain from mint config. If you do not have a configured subdomain, it uses the first subdomain on your account.

After registering the domain, the CLI waits up to 10 seconds for DNS records to generate, then prints the TXT and CNAME records to add at your domain provider:

TXT _acme-challenge → <value>
TXT _cf-custom-hostname → <value>
CNAME @ → cname.mintlify.builders

Add the TXT records first, then add the CNAME once the verification records validate. See Custom domain for full DNS setup instructions, apex domain requirements, and TLS provisioning details.

When you pass --basePath, the CLI saves the base path after registering the domain. The new path takes effect on your next deploy, and your site continues serving from the current path until then. The CNAME sends all traffic on the domain to Mintlify, so only add it if the domain hosts nothing else. Otherwise, keep your existing DNS and set up a reverse proxy to Mintlify for the base path. See Host docs at a subpath for provider-specific guides.

Examples

Add a custom domain at the root:

mint add-domain docs.example.com

Add a custom domain and serve your documentation at /docs:

mint add-domain example.com --basePath /docs

mint automations

Create, list, and delete automations from the terminal. Requires authentication with mint login.

mint automations <subcommand> [flags]

All subcommands accept these shared flags:

When --format json is set, errors print to stderr as Error: <message> and the command exits with a non-zero status, so you can pipe successful output into other tools.

mint automations create

Create a new automation. You can pass the automation definition inline with flags, or point at a JSON or YAML file with --file.

mint automations create [flags]

Provide exactly one trigger: pass --cron for a scheduled automation or one or more --push-repo flags for a push-triggered automation.

Examples

# Scheduled translations automation
mint automations create \
  --name "Translate content" \
  --type translations \
  --cron "0 6 * * *"

# Push-triggered automation with extra context
mint automations create \
  --name "Sync API reference" \
  --type source-code-agent \
  --push-repo my-org/api \
  --context-repo my-org/shared-types \
  --automerge

# Create from a file
mint automations create --file automation.yaml

An automation file uses the same shape as the inline flags. The on field holds the trigger:

name: Translate content
type: translations
on:
  cron: "0 6 * * *"
prompt: Prefer formal tone in French translations.
automerge: false
context:
  - repo: my-org/shared-content

mint automations list

List automations for the current deployment.

mint automations list [flags]

The default table output shows each automation’s ID, name, type, trigger, and status. Use --format json to get the full automation objects.

mint automations delete

Delete an automation by ID. Use mint automations list to get the ID.

mint automations delete <id> [flags]

mint config

Manage persistent default values for CLI commands. The configuration saves in ~/.config/mintlify/config.json.

mint config <subcommand> <key> [value]

Configuration keys

mint broken-links

Check for broken internal links in your documentation.

mint broken-links [flags]

The command scans .mdx and .md files for links and excludes files matching .mintignore patterns. Links inside OpenAPI specification files (.yaml, .yml, .json) are not checked. Links that point to ignored files report as broken.

Pass --files to limit the check to specific pages. This is useful for validating a single page you just edited or scoping checks to a directory in CI. When --files is set with --check-external, only external URLs on the selected pages are fetched.

# Check a specific page
mint broken-links --files introduction.mdx

# Check pages matching a glob
mint broken-links --files "guides/**/*.mdx"

# Pass multiple paths
mint broken-links --files introduction.mdx "guides/**/*.mdx"

mint a11y

Check for accessibility issues in your documentation.

mint a11y [flags]

Checks color contrast ratios and missing alt text on images and videos.

mint validate

Validate your documentation build in strict mode. Exits with an error if there are any warnings or errors. Includes automatic validation of OpenAPI specifications referenced in your docs.json.

mint validate [flags]

mint export

Export your documentation as a self-contained zip archive for offline viewing and distribution.

mint export [flags]

See Offline export for details.

mint score

Run agent readiness checks against a public documentation site. Requires authentication with mint login.

mint score [url] [flags]

The command displays an overall readiness score and a breakdown of individual checks with pass/fail indicators.

Examples

# Score your default subdomain
mint score

# Score a specific site
mint score docs.example.com

Checks

The score evaluates the following areas:

Some checks only run if a check they depend on passes. If a check fails, none of the checks that depend on it run. They automatically fail. For example, llmsTxtValid only passes if llmsTxtExists passes first.

The overall score uses weighted scoring, so higher-impact checks contribute more to your score.

mint deslop

Check documentation pages for AI-sounding prose and get rewrite suggestions. Requires authentication with mint login.

mint deslop [files...] [flags]

For each flagged page, the command reports the AI-written fraction, the specific passages that read as AI-generated with their line numbers, and suggested human-style rewrites.

Each checked page consumes one AI credit. The command skips pages under 50 words and does not charge for them. If any page is at or above the threshold, or if a check returns an error, the command exits with code 1. If every page is clean, the command exits with code 0. This lets you run the command in a rewrite loop or in CI.

Examples

# Check pages changed in your working tree
mint deslop

# Check a specific page
mint deslop docs/guide.mdx

# Check every MDX page and emit JSON for scripting
mint deslop "docs/**/*.mdx" --format json

# Also clean up whitespace in the checked files
mint deslop docs/guide.mdx --fix-whitespace

mint format

Format every .mdx file in the current directory to Mintlify’s canonical style. The command parses each file with the same MDX parser the web editor uses, then rewrites it in place if the canonical output differs.

mint format

Run the command from the root of your docs project. It walks every subdirectory, skipping paths matched by .gitignore and any Mintlify ignore rules. Files that already match the canonical output are left untouched.

When it finishes, the command prints how many MDX files were reformatted and how many failed to parse. If any file fails, the command exits with code 1 and prints the file path and error, so you can run it in CI to enforce consistent formatting.

mint new

Create a new documentation project by picking a theme or cloning a pre-defined template from the mintlify/templates repository.

mint new [directory] [flags]

mint update

Update the CLI to the latest version.

mint update

mint version

Display the current CLI and client versions.

mint version

Coming soon

These commands are available to run but are not yet functional. Running them records your interest through CLI telemetry and helps prioritize what ships next.

Telemetry

The CLI collects anonymous usage telemetry to help improve Mintlify. Telemetry data includes the command name, CLI version, operating system, and architecture. Mintlify does not collect personally identifiable information, project content, or file paths.

By default, the CLI collects telemetry data. You can opt out at any time using the --telemetry flag:

# Disable telemetry
mint --telemetry false

# Re-enable telemetry
mint --telemetry true

You can also disable telemetry by setting one of these environment variables:

Your preference saves in ~/.config/mintlify/config.json and persists across CLI sessions.