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
98 changes: 97 additions & 1 deletion cli/commands.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Commands"
description: "Complete reference for every Mintlify CLI command and flag, including mint dev, mint build, mint validate, mint analytics, and more."

Check warning on line 3 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L3

Use 'Dev' instead of 'dev'.
keywords: ["CLI", "mint", "commands", "flags", "reference"]
boost: 3
---
Expand Down Expand Up @@ -142,7 +142,7 @@
| --- | --- |
| `--page` | Filter conversations that reference a specific page in sources. |

#### `mint analytics conversation view <conversation-id>`

Check warning on line 145 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L145

'````' should use sentence-style capitalization.

View a single conversation by ID. Use `mint analytics conversation list` to get IDs.

Expand All @@ -158,7 +158,7 @@
mint analytics conversation buckets list
```

#### `mint analytics conversation buckets view <bucket-id>`

Check warning on line 161 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L161

'````' should use sentence-style capitalization.

View conversations in a category bucket. Use `mint analytics conversation buckets list` to get IDs.

Expand All @@ -168,6 +168,102 @@

---

## `mint workflow`

Create, list, and delete [workflows](/workflows) from the terminal. Requires authentication with `mint login`.

```bash
mint workflow <subcommand> [flags]
```

All subcommands accept these shared flags:

| Flag | Description |
| --- | --- |
| `--subdomain` | Documentation subdomain. Defaults to the value set with `mint config set subdomain`, or the first project on your account. |
| `--format` | Output format: `table` (default, pretty) or `json` (raw, machine-readable). |

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 workflow create`

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

```bash
mint workflow create [flags]
```

| Flag | Description |
| --- | --- |
| `--name` | Workflow name. Required unless `--file` is provided. |
| `--prompt` | Instructions appended to the workflow's base prompt on every run. |
| `--type` | Workflow type. One of `changelog`, `source-code-agent`, `translations`, `writing-style`, `typo-check`, `broken-link-detection`, `seo-metadata-audit`, `assistant-docs-updates`, or `contextual-feedback-docs-updates`. Omit for a custom workflow. |
| `--cron` | Cron expression for a scheduled trigger. Mutually exclusive with `--push-repo`. |

Check warning on line 201 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L201

Use 'cron' instead of 'Cron'.
| `--push-repo` | Repository (`owner/repo`) for a push trigger. Repeatable to listen to multiple repositories. Mutually exclusive with `--cron`. |
| `--context-repo` | Additional context repository (`owner/repo`) the agent reads when the workflow runs. Repeatable, up to 10 total. |
| `--automerge` | Automatically merge pull requests opened by this workflow. See [Configure automerge](/guides/configure-automerge) for setup requirements. |
| `--file` | Path to a JSON or YAML file containing the full workflow body. Overrides the inline flags. |

Exactly one trigger is required: pass `--cron` for a scheduled workflow or one or more `--push-repo` flags for a push-triggered workflow.

Check warning on line 207 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L207

In general, use active voice instead of passive voice ('is required').

#### Examples

```bash
# Scheduled translations workflow
mint workflow create \
--name "Translate content" \
--type translations \
--cron "0 6 * * *"

# Push-triggered workflow with extra context
mint workflow 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 workflow create --file workflow.yaml
```

A workflow file uses the same shape as the inline flags. The `on` field holds the trigger:

```yaml
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 workflow list`

List workflows for the current deployment.

```bash
mint workflow list [flags]
```

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

### `mint workflow delete`

Delete a workflow by ID. Use `mint workflow list` to get the ID.

```bash
mint workflow delete <id> [flags]
```

| Argument | Description |
| --- | --- |
| `id` | Workflow schema ID to delete. |

---

## `mint config`

Manage persistent default values for CLI commands. The configuration saves in `~/.config/mintlify/config.json`.
Expand All @@ -176,7 +272,7 @@
mint config <subcommand> <key> [value]
```

| Subcommand | Description |

Check warning on line 275 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L275

Use 'subcommands?' instead of 'Subcommand'.
| --- | --- |
| `set <key> <value>` | Set a configuration value. |
| `get <key>` | Display a configuration value. |
Expand All @@ -186,7 +282,7 @@

| Key | Description | Used by |
| --- | --- | --- |
| `subdomain` | Default documentation subdomain. | `mint analytics` |
| `subdomain` | Default documentation subdomain. | `mint analytics`, `mint workflow` |
| `dateFrom` | Default start date for analytics queries (`YYYY-MM-DD`). | `mint analytics` |
| `dateTo` | Default end date for analytics queries (`YYYY-MM-DD`). | `mint analytics` |

Expand Down Expand Up @@ -243,7 +339,7 @@
| `--local-schema` | Allow validation of locally hosted OpenAPI files served over HTTP. Only supports HTTPS in production. |

<Note>
The standalone `mint openapi-check` command is deprecated. Use `mint validate` instead.

Check warning on line 342 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L342

In general, use active voice instead of passive voice ('is deprecated').
</Note>

---
Expand Down Expand Up @@ -379,7 +475,7 @@

## 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.

Check warning on line 478 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L478

Did you really mean 'informat'?

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

Expand Down
108 changes: 107 additions & 1 deletion es/cli/commands.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,112 @@ mint analytics conversation buckets view <bucket-id>

---

<div id="mint-workflow">
## `mint workflow`
</div>

Crea, lista y elimina [workflows](/es/workflows) desde la terminal. Requiere autenticación con `mint login`.

```bash
mint workflow <subcommand> [flags]
```

Todos los subcomandos aceptan estos flags compartidos:

| Flag | Descripción |
| --- | --- |
| `--subdomain` | Subdominio de la documentación. Por defecto usa el valor establecido con `mint config set subdomain`, o el primer proyecto de tu cuenta. |
| `--format` | Formato de salida: `table` (por defecto, en formato legible) o `json` (sin procesar, legible por máquinas). |

Cuando se establece `--format json`, los errores se imprimen en stderr como `Error: <message>` y el comando sale con un estado distinto de cero, para que puedas canalizar la salida exitosa a otras herramientas.

<div id="mint-workflow-create">
### `mint workflow create`
</div>

Crea un nuevo workflow. Puedes pasar la definición del workflow en línea con flags, o apuntar a un archivo JSON o YAML con `--file`.

```bash
mint workflow create [flags]
```

| Flag | Descripción |
| --- | --- |
| `--name` | Nombre del workflow. Obligatorio salvo que se proporcione `--file`. |
| `--prompt` | Instrucciones que se añaden al prompt base del workflow en cada ejecución. |
| `--type` | Tipo de workflow. Uno de `changelog`, `source-code-agent`, `translations`, `writing-style`, `typo-check`, `broken-link-detection`, `seo-metadata-audit`, `assistant-docs-updates` o `contextual-feedback-docs-updates`. Omítelo para un workflow personalizado. |
| `--cron` | Expresión cron para un trigger programado. Mutuamente excluyente con `--push-repo`. |
| `--push-repo` | Repositorio (`owner/repo`) para un trigger de push. Repetible para escuchar varios repositorios. Mutuamente excluyente con `--cron`. |
| `--context-repo` | Repositorio de contexto adicional (`owner/repo`) que el agente lee cuando se ejecuta el workflow. Repetible, hasta 10 en total. |
| `--automerge` | Fusiona automáticamente las pull requests abiertas por este workflow. Consulta [Configurar automerge](/es/guides/configure-automerge) para los requisitos de configuración. |
| `--file` | Ruta a un archivo JSON o YAML con el cuerpo completo del workflow. Anula los flags en línea. |

Se requiere exactamente un trigger: pasa `--cron` para un workflow programado o uno o más flags `--push-repo` para un workflow activado por push.

<div id="examples">
#### Ejemplos
</div>

```bash
# Workflow de traducciones programado
mint workflow create \
--name "Translate content" \
--type translations \
--cron "0 6 * * *"

# Workflow activado por push con contexto adicional
mint workflow create \
--name "Sync API reference" \
--type source-code-agent \
--push-repo my-org/api \
--context-repo my-org/shared-types \
--automerge

# Crear desde un archivo
mint workflow create --file workflow.yaml
```

Un archivo de workflow usa la misma forma que los flags en línea. El campo `on` contiene el trigger:

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

<div id="mint-workflow-list">
### `mint workflow list`
</div>

Lista los workflows del despliegue actual.

```bash
mint workflow list [flags]
```

La salida en formato tabla por defecto muestra el ID, nombre, tipo, trigger y estado de cada workflow. Usa `--format json` para obtener los objetos completos del workflow.

<div id="mint-workflow-delete">
### `mint workflow delete`
</div>

Elimina un workflow por ID. Usa `mint workflow list` para obtener el ID.

```bash
mint workflow delete <id> [flags]
```

| Argumento | Descripción |
| --- | --- |
| `id` | ID del esquema del workflow que se va a eliminar. |

---

<div id="mint-config">
## `mint config`
</div>
Expand All @@ -218,7 +324,7 @@ mint config <subcommand> <key> [value]

| Clave | Descripción | Usado por |
| --- | --- | --- |
| `subdomain` | Subdominio predeterminado de la documentación. | `mint analytics` |
| `subdomain` | Subdominio predeterminado de la documentación. | `mint analytics`, `mint workflow` |
| `dateFrom` | Fecha de inicio predeterminada para consultas de analítica (`YYYY-MM-DD`). | `mint analytics` |
| `dateTo` | Fecha de fin predeterminada para consultas de analítica (`YYYY-MM-DD`). | `mint analytics` |

Expand Down
4 changes: 4 additions & 0 deletions es/workflows/manage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ import GitlabWorkflowSetup from '/snippets/es/gitlab-workflow-setup.mdx';
- Para GitHub: la [Mintlify GitHub App](/es/deploy/github) instalada en cada repositorio que planees usar en el workflow
- Para GitLab: una cuenta de GitLab conectada (consulta [Configuración de GitLab](#gitlab-setup) a continuación)

<Tip>
También puedes crear, listar y eliminar workflows desde la terminal con [`mint workflow`](/es/cli/commands#mint-workflow). La CLI es útil para scripting y CI; el panel es la forma más sencilla de configurar y monitorear las ejecuciones de los workflows.
</Tip>

<div id="enable-a-workflow">
## Activar un workflow
</div>
Expand Down
108 changes: 107 additions & 1 deletion fr/cli/commands.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,112 @@ mint analytics conversation buckets view <bucket-id>

---

<div id="mint-workflow">
## `mint workflow`
</div>

Créez, listez et supprimez des [workflows](/fr/workflows) depuis le terminal. Nécessite une authentification avec `mint login`.

```bash
mint workflow <subcommand> [flags]
```

Tous les sous-commandes acceptent ces flags partagés :

| Flag | Description |
| --- | --- |
| `--subdomain` | Sous-domaine de la documentation. Par défaut, utilise la valeur définie avec `mint config set subdomain`, ou le premier projet de votre compte. |
| `--format` | Format de sortie : `table` (par défaut, lisible) ou `json` (brut, lisible par machine). |

Lorsque `--format json` est défini, les erreurs sont écrites sur stderr sous la forme `Error: <message>` et la commande se termine avec un statut non nul, afin que vous puissiez rediriger la sortie réussie vers d'autres outils.

<div id="mint-workflow-create">
### `mint workflow create`
</div>

Crée un nouveau workflow. Vous pouvez passer la définition du workflow en ligne avec des flags, ou pointer vers un fichier JSON ou YAML avec `--file`.

```bash
mint workflow create [flags]
```

| Flag | Description |
| --- | --- |
| `--name` | Nom du workflow. Obligatoire sauf si `--file` est fourni. |
| `--prompt` | Instructions ajoutées au prompt de base du workflow à chaque exécution. |
| `--type` | Type de workflow. L'une des valeurs suivantes : `changelog`, `source-code-agent`, `translations`, `writing-style`, `typo-check`, `broken-link-detection`, `seo-metadata-audit`, `assistant-docs-updates` ou `contextual-feedback-docs-updates`. Omettez pour un workflow personnalisé. |
| `--cron` | Expression cron pour un trigger planifié. Mutuellement exclusif avec `--push-repo`. |
| `--push-repo` | Dépôt (`owner/repo`) pour un trigger de push. Répétable pour écouter plusieurs dépôts. Mutuellement exclusif avec `--cron`. |
| `--context-repo` | Dépôt de contexte supplémentaire (`owner/repo`) que l'agent lit lors de l'exécution du workflow. Répétable, jusqu'à 10 au total. |
| `--automerge` | Fusionne automatiquement les pull requests ouvertes par ce workflow. Consultez [Configurer l'automerge](/fr/guides/configure-automerge) pour les prérequis de configuration. |
| `--file` | Chemin vers un fichier JSON ou YAML contenant le corps complet du workflow. Remplace les flags en ligne. |

Exactement un trigger est requis : passez `--cron` pour un workflow planifié ou un ou plusieurs flags `--push-repo` pour un workflow déclenché par push.

<div id="examples">
#### Exemples
</div>

```bash
# Workflow de traductions planifié
mint workflow create \
--name "Translate content" \
--type translations \
--cron "0 6 * * *"

# Workflow déclenché par push avec contexte supplémentaire
mint workflow create \
--name "Sync API reference" \
--type source-code-agent \
--push-repo my-org/api \
--context-repo my-org/shared-types \
--automerge

# Créer à partir d'un fichier
mint workflow create --file workflow.yaml
```

Un fichier de workflow utilise la même structure que les flags en ligne. Le champ `on` contient le trigger :

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

<div id="mint-workflow-list">
### `mint workflow list`
</div>

Liste les workflows pour le déploiement actuel.

```bash
mint workflow list [flags]
```

La sortie sous forme de tableau par défaut affiche l'ID, le nom, le type, le trigger et le statut de chaque workflow. Utilisez `--format json` pour obtenir les objets workflow complets.

<div id="mint-workflow-delete">
### `mint workflow delete`
</div>

Supprime un workflow par ID. Utilisez `mint workflow list` pour obtenir l'ID.

```bash
mint workflow delete <id> [flags]
```

| Argument | Description |
| --- | --- |
| `id` | ID du schéma du workflow à supprimer. |

---

<div id="mint-config">
## `mint config`
</div>
Expand All @@ -218,7 +324,7 @@ mint config <subcommand> <key> [value]

| Clé | Description | Utilisé par |
| --- | --- | --- |
| `subdomain` | Sous-domaine par défaut de la documentation. | `mint analytics` |
| `subdomain` | Sous-domaine par défaut de la documentation. | `mint analytics`, `mint workflow` |
| `dateFrom` | Date de début par défaut pour les requêtes d'analytique (`YYYY-MM-DD`). | `mint analytics` |
| `dateTo` | Date de fin par défaut pour les requêtes d'analytique (`YYYY-MM-DD`). | `mint analytics` |

Expand Down
4 changes: 4 additions & 0 deletions fr/workflows/manage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ import GitlabWorkflowSetup from '/snippets/fr/gitlab-workflow-setup.mdx';
- Pour GitHub : l'[application GitHub Mintlify](/fr/deploy/github) installée sur chaque dépôt que vous prévoyez d'utiliser dans le workflow
- Pour GitLab : un compte GitLab connecté (voir [Configuration GitLab](#gitlab-setup) ci-dessous)

<Tip>
Vous pouvez également créer, lister et supprimer des workflows depuis le terminal avec [`mint workflow`](/fr/cli/commands#mint-workflow). La CLI est utile pour les scripts et l'intégration continue ; le tableau de bord est le moyen le plus simple de configurer et de surveiller les exécutions des workflows.
</Tip>

<div id="enable-a-workflow">
## Activer un workflow
</div>
Expand Down
4 changes: 4 additions & 0 deletions workflows/manage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@
- For GitHub: the [Mintlify GitHub App](/deploy/github) installed on every repository you plan to use in the workflow
- For GitLab: a connected GitLab account (see [GitLab setup](#gitlab-setup) below)

<Tip>
You can also create, list, and delete workflows from the terminal with [`mint workflow`](/cli/commands#mint-workflow). The CLI is useful for scripting and CI; the dashboard is the easiest way to configure and monitor workflow runs.
</Tip>

## Enable a workflow

1. Open the [Workflows](https://app.mintlify.com/products/workflows?tab=workflows) page in your dashboard.
Expand All @@ -37,9 +41,9 @@

Each workflow has a default trigger that controls when it runs. To change the trigger, select a different option in the settings panel.

- **Content update** — Runs when content is pushed to your project repository, including pull request merges and direct pushes.

Check warning on line 44 in workflows/manage.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

workflows/manage.mdx#L44

Don't put a space before or after a dash.

Check warning on line 44 in workflows/manage.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

workflows/manage.mdx#L44

In general, use active voice instead of passive voice ('is pushed').
- **Code change** — Runs when a pull request merges in a connected source code repository. You must specify at least one source repository.

Check warning on line 45 in workflows/manage.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

workflows/manage.mdx#L45

Don't put a space before or after a dash.
- **Custom schedule** — Runs on a recurring schedule you define. Workflows queue within 10 minutes of the scheduled time.

Check warning on line 46 in workflows/manage.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

workflows/manage.mdx#L46

Don't put a space before or after a dash.

### Update mode

Expand Down
Loading