From 2048e1bd82e9a404fc281a928ca257acfd626f5a Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Sat, 30 May 2026 15:10:26 +0000 Subject: [PATCH 1/2] docs: document mint workflow CLI command --- cli/commands.mdx | 98 +++++++++++++++++++++++++++++++++++++++++++- workflows/manage.mdx | 4 ++ 2 files changed, 101 insertions(+), 1 deletion(-) diff --git a/cli/commands.mdx b/cli/commands.mdx index 92cdda4198..57c691431f 100644 --- a/cli/commands.mdx +++ b/cli/commands.mdx @@ -168,6 +168,102 @@ mint analytics conversation buckets view --- +## `mint workflow` + +Create, list, and delete [workflows](/workflows) from the terminal. Requires authentication with `mint login`. + +```bash +mint workflow [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: ` 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`. | +| `--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. + +#### 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 [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`. @@ -186,7 +282,7 @@ mint config [value] | 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` | diff --git a/workflows/manage.mdx b/workflows/manage.mdx index 34b0c40fc4..815da4293e 100644 --- a/workflows/manage.mdx +++ b/workflows/manage.mdx @@ -12,6 +12,10 @@ import GitlabWorkflowSetup from '/snippets/gitlab-workflow-setup.mdx'; - 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) + + 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. + + ## Enable a workflow 1. Open the [Workflows](https://app.mintlify.com/products/workflows?tab=workflows) page in your dashboard. From 32f09f495442b53eb85e6aa9bdbcb1cbcc67d351 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Sat, 30 May 2026 15:13:00 +0000 Subject: [PATCH 2/2] docs: translate mint workflow CLI docs to es and fr --- es/cli/commands.mdx | 108 +++++++++++++++++++++++++++++++++++++++- es/workflows/manage.mdx | 4 ++ fr/cli/commands.mdx | 108 +++++++++++++++++++++++++++++++++++++++- fr/workflows/manage.mdx | 4 ++ 4 files changed, 222 insertions(+), 2 deletions(-) diff --git a/es/cli/commands.mdx b/es/cli/commands.mdx index 5f029ef000..b11cd3d3fe 100644 --- a/es/cli/commands.mdx +++ b/es/cli/commands.mdx @@ -196,6 +196,112 @@ mint analytics conversation buckets view --- +
+ ## `mint workflow` +
+ +Crea, lista y elimina [workflows](/es/workflows) desde la terminal. Requiere autenticación con `mint login`. + +```bash +mint workflow [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: ` y el comando sale con un estado distinto de cero, para que puedas canalizar la salida exitosa a otras herramientas. + +
+ ### `mint workflow create` +
+ +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. + +
+ #### Ejemplos +
+ +```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 +``` + +
+ ### `mint workflow list` +
+ +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. + +
+ ### `mint workflow delete` +
+ +Elimina un workflow por ID. Usa `mint workflow list` para obtener el ID. + +```bash +mint workflow delete [flags] +``` + +| Argumento | Descripción | +| --- | --- | +| `id` | ID del esquema del workflow que se va a eliminar. | + +--- +
## `mint config`
@@ -218,7 +324,7 @@ mint config [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` | diff --git a/es/workflows/manage.mdx b/es/workflows/manage.mdx index bdd582021a..a70cd21aff 100644 --- a/es/workflows/manage.mdx +++ b/es/workflows/manage.mdx @@ -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) + + 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. + +
## Activar un workflow
diff --git a/fr/cli/commands.mdx b/fr/cli/commands.mdx index 06bc1a9c27..623b57bf5d 100644 --- a/fr/cli/commands.mdx +++ b/fr/cli/commands.mdx @@ -196,6 +196,112 @@ mint analytics conversation buckets view --- +
+ ## `mint workflow` +
+ +Créez, listez et supprimez des [workflows](/fr/workflows) depuis le terminal. Nécessite une authentification avec `mint login`. + +```bash +mint workflow [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: ` et la commande se termine avec un statut non nul, afin que vous puissiez rediriger la sortie réussie vers d'autres outils. + +
+ ### `mint workflow create` +
+ +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. + +
+ #### Exemples +
+ +```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 +``` + +
+ ### `mint workflow list` +
+ +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. + +
+ ### `mint workflow delete` +
+ +Supprime un workflow par ID. Utilisez `mint workflow list` pour obtenir l'ID. + +```bash +mint workflow delete [flags] +``` + +| Argument | Description | +| --- | --- | +| `id` | ID du schéma du workflow à supprimer. | + +--- +
## `mint config`
@@ -218,7 +324,7 @@ mint config [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` | diff --git a/fr/workflows/manage.mdx b/fr/workflows/manage.mdx index 16154fad85..f5a46de0ed 100644 --- a/fr/workflows/manage.mdx +++ b/fr/workflows/manage.mdx @@ -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) + + 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. + +
## Activer un workflow