@mintlify/cli 4.0.1813 → 4.1.2

package/src/welcome.ts

@@ -1,154 +0,0 @@
-import chalk from 'chalk';
-
-const MINT_GREEN = '#18E299';
-
-const mint = chalk.hex(MINT_GREEN);
-
-interface CommandEntry {
-  name: string;
-  description: string;
-}
-
-interface CommandGroup {
-  title: string;
-  commands: CommandEntry[];
-}
-
-const GROUPS: CommandGroup[] = [
-  {
-    title: 'Preview',
-    commands: [
-      { name: 'dev', description: 'Start a local preview of your site' },
-      { name: 'new', description: 'Scaffold a new documentation site' },
-      {
-        name: 'deploy',
-        description: 'Provision a docs site without login; get Git push instructions',
-      },
-    ],
-  },
-  {
-    title: 'Quality',
-    commands: [
-      { name: 'validate', description: 'Validate the site build (strict)' },
-      {
-        name: 'broken-links',
-        description: 'Find broken links before you ship',
-      },
-      { name: 'a11y', description: 'Check site for accessibility issues' },
-      { name: 'score', description: 'Run agent-readiness checks' },
-    ],
-  },
-  {
-    title: 'Insights',
-    commands: [
-      { name: 'analytics', description: 'View analytics for your site' },
-      { name: 'automations', description: 'Create and manage automations' },
-    ],
-  },
-  {
-    title: 'Account',
-    commands: [
-      { name: 'login', description: 'Authenticate with Mintlify' },
-      { name: 'claim', description: 'Claim a site created with mint deploy' },
-      { name: 'logout', description: 'Sign out on this device' },
-      { name: 'status', description: 'View authentication status' },
-    ],
-  },
-  {
-    title: 'CLI',
-    commands: [
-      { name: 'agent setup', description: 'Install Mintlify skills and configure Admin MCP' },
-      { name: 'config', description: 'Manage CLI configuration' },
-      { name: 'instructions', description: 'Print Mintlify workflow instructions' },
-      { name: 'update', description: 'Update to the latest version' },
-    ],
-  },
-];
-
-const EXAMPLES: CommandEntry[] = [
-  { name: 'dev', description: 'Start a local preview of your site' },
-  { name: 'new docs', description: 'Scaffold a new site in ./docs' },
-  {
-    name: 'claim --email you@example.com',
-    description: 'Get a claim link; use the deployment directory',
-  },
-  { name: 'claim --code <code>', description: 'Finish the claim in the same directory' },
-  { name: 'validate', description: 'Validate your site before shipping' },
-  { name: 'broken-links', description: 'Find broken links across your site' },
-];
-
-const COMMAND_NAME_WIDTH =
-  GROUPS.flatMap((group) => group.commands).reduce(
-    (max, command) => Math.max(max, command.name.length),
-    0
-  ) + 2;
-
-// `name  description`, name padded to a shared column and colored mint. Padding
-// is computed on the raw name so ANSI codes don't throw off the alignment.
-const commandRow = (name: string, description: string, nameWidth: number, indent: number): string =>
-  ' '.repeat(indent) + mint(name.padEnd(nameWidth)) + chalk.dim(description);
-
-export interface WelcomeOptions {
-  packageName: string;
-  version?: string;
-  signedIn: boolean;
-  subdomain?: string;
-}
-
-/**
- * Builds the branded welcome / help screen as a ready-to-print string: the
- * Mintlify leaf beside an identity block, then grouped examples and commands.
- */
-export function renderWelcome({
-  packageName,
-  version,
-  signedIn,
-  subdomain,
-}: WelcomeOptions): string {
-  const title = `${packageName.charAt(0).toUpperCase()}${packageName.slice(1)} CLI`;
-  // Only prefix "v" for real semver versions; the linked-dev build reports a
-  // descriptive string ("linked to local package").
-  const versionLabel = version ? (/^\d/.test(version) ? `v${version}` : version) : undefined;
-
-  const identity: string[] = [
-    chalk.bold(title) + (versionLabel ? chalk.dim(` ${versionLabel}`) : ''),
-    '',
-    signedIn
-      ? chalk.dim('Signed in to Mintlify')
-      : chalk.dim('Run ') + mint(`${packageName} login`) + chalk.dim(' to sign in'),
-    ...(subdomain ? [chalk.dim(`Project ${subdomain}`)] : []),
-  ];
-
-  const lines: string[] = [''];
-
-  lines.push(...identity);
-
-  // Examples.
-  const exampleWidth =
-    EXAMPLES.reduce((max, example) => Math.max(max, `${packageName} ${example.name}`.length), 0) +
-    2;
-  lines.push('', ' ' + chalk.bold('EXAMPLES'));
-  for (const example of EXAMPLES) {
-    lines.push(commandRow(`${packageName} ${example.name}`, example.description, exampleWidth, 3));
-  }
-
-  // Commands, grouped.
-  lines.push('', ' ' + chalk.bold('COMMANDS'));
-  for (const group of GROUPS) {
-    lines.push('', '   ' + chalk.bold(group.title));
-    for (const command of group.commands) {
-      lines.push(commandRow(command.name, command.description, COMMAND_NAME_WIDTH, 5));
-    }
-  }
-
-  lines.push(
-    '',
-    ' ' +
-      chalk.dim('Run ') +
-      mint(`${packageName} <command> --help`) +
-      chalk.dim(' for details on any command.'),
-    ''
-  );
-
-  return lines.join('\n') + '\n';
-}

package/src/workflows/client.ts

@@ -1,39 +0,0 @@
-import { authenticatedFetch } from '../authenticatedFetch.js';
-import { API_URL } from '../constants.js';
-import type { Workflow, WorkflowBody } from './types.js';
-
-async function request<T>(path: string, init?: RequestInit): Promise<T> {
-  const res = await authenticatedFetch(`${API_URL}/api/cli/workflows${path}`, {
-    ...init,
-    headers: { Accept: 'application/json', ...init?.headers },
-  });
-
-  if (!res.ok) {
-    const body = await res.text().catch(() => '');
-    throw new Error(`API error (${res.status}): ${body || res.statusText}`);
-  }
-
-  return res.json() as Promise<T>;
-}
-
-export function createWorkflow(subdomain: string, body: WorkflowBody): Promise<Workflow> {
-  return request<Workflow>(`/${encodeURIComponent(subdomain)}`, {
-    method: 'POST',
-    headers: { 'Content-Type': 'application/json' },
-    body: JSON.stringify(body),
-  });
-}
-
-export function listWorkflows(subdomain: string): Promise<Workflow[]> {
-  return request<Workflow[]>(`/${encodeURIComponent(subdomain)}`);
-}
-
-export function deleteWorkflow(
-  subdomain: string,
-  workflowSchemaId: string
-): Promise<{ success: boolean }> {
-  return request<{ success: boolean }>(
-    `/${encodeURIComponent(subdomain)}/${encodeURIComponent(workflowSchemaId)}`,
-    { method: 'DELETE' }
-  );
-}

package/src/workflows/index.tsx

@@ -1,287 +0,0 @@
-import { addLog, ErrorLog, SpinnerLog, SuccessLog, removeLastLog } from '@mintlify/previewing';
-import chalk from 'chalk';
-import { Text } from 'ink';
-import yaml from 'js-yaml';
-import fs from 'node:fs/promises';
-import path from 'node:path';
-import type { Argv } from 'yargs';
-
-import { CMD_EXEC_PATH, terminate } from '../helpers.js';
-import { subdomainMiddleware } from '../middlewares/subdomainMiddleware.js';
-import { trackEvent } from '../telemetry/track.js';
-import { createWorkflow, deleteWorkflow, listWorkflows } from './client.js';
-import {
-  WORKFLOW_TYPES,
-  type Workflow,
-  type WorkflowBody,
-  type WorkflowTrigger,
-  type WorkflowType,
-} from './types.js';
-
-type CreateArgs = {
-  subdomain?: string;
-  name?: string;
-  prompt?: string;
-  type?: string;
-  cron?: string;
-  pushRepo?: (string | number)[];
-  contextRepo?: (string | number)[];
-  automerge?: boolean;
-  file?: string;
-  format?: string;
-};
-
-type OutputFormat = 'table' | 'json';
-
-function resolveFormat(argv: { format?: string }): OutputFormat {
-  return argv.format === 'json' ? 'json' : 'table';
-}
-
-function output(format: OutputFormat, text: string) {
-  if (format === 'table') {
-    addLog(<Text>{text}</Text>);
-  } else {
-    process.stdout.write(text + '\n');
-  }
-}
-
-function requireSubdomain(subdomain: string | undefined): string {
-  if (!subdomain) {
-    throw new Error(
-      'No subdomain set. Pass --subdomain, or run `mint config set subdomain <name>`.'
-    );
-  }
-  return subdomain;
-}
-
-async function readWorkflowFile(filePath: string): Promise<unknown> {
-  const resolved = path.isAbsolute(filePath) ? filePath : path.join(CMD_EXEC_PATH, filePath);
-  const contents = await fs.readFile(resolved, 'utf-8');
-  if (/\.ya?ml$/i.test(resolved)) return yaml.load(contents);
-  return JSON.parse(contents);
-}
-
-function buildTriggerFromFlags(argv: CreateArgs): WorkflowTrigger {
-  const repos = (argv.pushRepo ?? []).map(String).filter(Boolean);
-  if (argv.cron && repos.length > 0) {
-    throw new Error('Specify either --cron or --push-repo, not both.');
-  }
-  if (argv.cron) return { cron: argv.cron };
-  if (repos.length > 0) return { push: repos.map((repo) => ({ repo })) };
-  throw new Error('A trigger is required. Pass --cron <expr> or --push-repo <owner/repo>.');
-}
-
-function buildBodyFromFlags(argv: CreateArgs): WorkflowBody {
-  if (!argv.name) {
-    throw new Error('--name is required when --file is not provided.');
-  }
-  const type = argv.type;
-  if (type !== undefined && !WORKFLOW_TYPES.includes(type as WorkflowType)) {
-    throw new Error(`Invalid --type "${type}". Valid types: ${WORKFLOW_TYPES.join(', ')}`);
-  }
-  const body: WorkflowBody = {
-    name: argv.name,
-    on: buildTriggerFromFlags(argv),
-  };
-  if (argv.prompt) body.prompt = argv.prompt;
-  if (type) body.type = type as WorkflowType;
-  if (argv.automerge !== undefined) body.automerge = argv.automerge;
-  const contextRepos = (argv.contextRepo ?? []).map(String).filter(Boolean);
-  if (contextRepos.length > 0) body.context = contextRepos.map((repo) => ({ repo }));
-  return body;
-}
-
-function describeTrigger(trigger: WorkflowTrigger): string {
-  if ('webhook' in trigger) return 'webhook';
-  if ('cron' in trigger) return `cron(${trigger.cron})`;
-  if ('push' in trigger) return `push(${trigger.push.map((p) => p.repo).join(', ')})`;
-  return `composio(${trigger.composio.toolkit}:${trigger.composio.triggerSlug})`;
-}
-
-function renderWorkflow(workflow: Workflow): string {
-  const lines: string[] = [];
-  lines.push(chalk.bold(`\nAutomation ${workflow.name}`));
-  lines.push(`  ${chalk.dim('ID')}        ${workflow._id}`);
-  lines.push(`  ${chalk.dim('Status')}    ${workflow.status}`);
-  if (workflow.type) lines.push(`  ${chalk.dim('Type')}      ${workflow.type}`);
-  lines.push(`  ${chalk.dim('Trigger')}   ${describeTrigger(workflow.trigger)}`);
-  if (workflow.automerge !== undefined) {
-    lines.push(`  ${chalk.dim('Automerge')} ${workflow.automerge}`);
-  }
-  return lines.join('\n');
-}
-
-function renderList(workflows: Workflow[]): string {
-  if (workflows.length === 0) return 'No automations found.';
-  const rows = workflows.map((w) => [
-    w._id,
-    w.name,
-    w.type ?? '—',
-    describeTrigger(w.trigger),
-    w.status,
-  ]);
-  const headers = ['ID', 'Name', 'Type', 'Trigger', 'Status'];
-  const widths = headers.map((h, i) => Math.max(h.length, ...rows.map((r) => String(r[i]).length)));
-  const fmt = (cells: string[]) => cells.map((c, i) => c.padEnd(widths[i]!)).join('  ');
-  return [chalk.bold(fmt(headers)), ...rows.map(fmt)].join('\n');
-}
-
-const withSubdomain = <T extends object>(yargs: Argv<T>) =>
-  yargs.option('subdomain', {
-    type: 'string' as const,
-    description: 'Documentation subdomain (default: mint config set subdomain)',
-  });
-
-const withFormat = <T extends object>(yargs: Argv<T>) =>
-  yargs.option('format', {
-    type: 'string' as const,
-    choices: ['table', 'json'] as const,
-    description: 'Output format (table=pretty, json=raw)',
-  });
-
-export const workflowsBuilder = (yargs: Argv) =>
-  yargs
-    .middleware(subdomainMiddleware)
-    .command(
-      'create',
-      'Create a new automation',
-      (yargs) =>
-        withFormat(
-          withSubdomain(yargs)
-            .option('name', { type: 'string', description: 'Automation name' })
-            .option('prompt', { type: 'string', description: 'Automation prompt' })
-            .option('type', {
-              type: 'string',
-              choices: WORKFLOW_TYPES,
-              description: 'Automation type',
-            })
-            .option('cron', {
-              type: 'string',
-              description: 'Cron expression for a scheduled trigger',
-            })
-            .option('push-repo', {
-              type: 'string',
-              array: true,
-              description: 'Repository (owner/repo) for a push trigger (repeatable)',
-            })
-            .option('context-repo', {
-              type: 'string',
-              array: true,
-              description: 'Additional context repository (repeatable)',
-            })
-            .option('automerge', {
-              type: 'boolean',
-              description: 'Automatically merge PRs opened by this automation',
-            })
-            .option('file', {
-              type: 'string',
-              description: 'Path to a JSON or YAML file with the full automation body',
-            })
-        )
-          .example(
-            'mint automations create --name Translations --cron "0 6 * * *" --type translations',
-            ''
-          )
-          .example('mint automations create --file automation.yaml', ''),
-      async (argv) => {
-        const format = resolveFormat(argv);
-        try {
-          const subdomain = requireSubdomain(argv.subdomain);
-          const body: WorkflowBody = argv.file
-            ? ((await readWorkflowFile(argv.file)) as WorkflowBody)
-            : buildBodyFromFlags(argv as CreateArgs);
-
-          if (format === 'table') addLog(<SpinnerLog message="Creating automation..." />);
-          const created = await createWorkflow(subdomain, body);
-          if (format === 'table') removeLastLog();
-
-          void trackEvent('cli.automation.created', {
-            subdomain,
-            type: created.type,
-            triggerKind: describeTrigger(created.trigger).split('(')[0],
-          });
-
-          if (format === 'json') {
-            output(format, JSON.stringify(created, null, 2));
-          } else {
-            addLog(<SuccessLog message={`Created automation ${created._id}`} />);
-            output(format, renderWorkflow(created));
-          }
-          await terminate(0);
-        } catch (err) {
-          if (format === 'table') removeLastLog();
-          const message = err instanceof Error ? err.message : 'unknown error';
-          if (format === 'json') {
-            process.stderr.write(`Error: ${message}\n`);
-          } else {
-            addLog(<ErrorLog message={message} />);
-          }
-          await terminate(1);
-        }
-      }
-    )
-    .command(
-      'list',
-      'List automations for the current deployment',
-      (yargs) => withFormat(withSubdomain(yargs)),
-      async (argv) => {
-        const format = resolveFormat(argv);
-        try {
-          const subdomain = requireSubdomain(argv.subdomain);
-          if (format === 'table') addLog(<SpinnerLog message="Fetching automations..." />);
-          const workflows = await listWorkflows(subdomain);
-          if (format === 'table') removeLastLog();
-
-          if (format === 'json') {
-            output(format, JSON.stringify(workflows, null, 2));
-          } else {
-            output(format, renderList(workflows));
-          }
-          await terminate(0);
-        } catch (err) {
-          if (format === 'table') removeLastLog();
-          const message = err instanceof Error ? err.message : 'unknown error';
-          if (format === 'json') {
-            process.stderr.write(`Error: ${message}\n`);
-          } else {
-            addLog(<ErrorLog message={message} />);
-          }
-          await terminate(1);
-        }
-      }
-    )
-    .command(
-      'delete <id>',
-      'Delete an automation by ID',
-      (yargs) =>
-        withFormat(withSubdomain(yargs)).positional('id', {
-          type: 'string',
-          demandOption: true,
-          description: 'Automation schema ID',
-        }),
-      async (argv) => {
-        const format = resolveFormat(argv);
-        try {
-          const subdomain = requireSubdomain(argv.subdomain);
-          if (format === 'table') addLog(<SpinnerLog message="Deleting automation..." />);
-          await deleteWorkflow(subdomain, argv.id);
-          if (format === 'table') removeLastLog();
-          if (format === 'json') {
-            output(format, JSON.stringify({ success: true, id: argv.id }, null, 2));
-          } else {
-            addLog(<SuccessLog message={`Deleted automation ${argv.id}`} />);
-          }
-          await terminate(0);
-        } catch (err) {
-          if (format === 'table') removeLastLog();
-          const message = err instanceof Error ? err.message : 'unknown error';
-          if (format === 'json') {
-            process.stderr.write(`Error: ${message}\n`);
-          } else {
-            addLog(<ErrorLog message={message} />);
-          }
-          await terminate(1);
-        }
-      }
-    )
-    .demandCommand(1, 'specify a subcommand: create, list, or delete');

package/src/workflows/types.ts

@@ -1,73 +0,0 @@
-export const WORKFLOW_TYPES = [
-  'changelog',
-  'source-code-agent',
-  'translations',
-  'writing-style',
-  'typo-check',
-  'broken-link-detection',
-  'seo-metadata-audit',
-  'assistant-docs-updates',
-  'contextual-feedback-docs-updates',
-] as const;
-export type WorkflowType = (typeof WORKFLOW_TYPES)[number];
-
-export type WorkflowCronTrigger = { cron: string };
-export type WorkflowWebhookTrigger = { webhook: true };
-export type WorkflowPushTrigger = { push: { repo: string; branch?: string }[] };
-export type WorkflowComposioTrigger = {
-  composio: {
-    toolkit: string;
-    triggerSlug: string;
-    composioTriggerId?: string;
-    triggerConfig?: Record<string, unknown>;
-  };
-};
-
-export type WorkflowTrigger =
-  | WorkflowCronTrigger
-  | WorkflowPushTrigger
-  | WorkflowComposioTrigger
-  | WorkflowWebhookTrigger;
-
-export type WorkflowContextItem = {
-  repo: string;
-  public?: boolean;
-};
-
-export type WorkflowNotify = {
-  slack?: {
-    channels?: string[];
-    channel_ids?: string[];
-    users?: string[];
-    user_ids?: string[];
-  };
-};
-
-export type WorkflowBody = {
-  name: string;
-  on: WorkflowTrigger;
-  prompt?: string;
-  type?: WorkflowType;
-  context?: WorkflowContextItem[];
-  automerge?: boolean;
-  notify?: WorkflowNotify;
-  config?: { translations?: { targetLanguages: string[] } };
-  tools?: { composio?: { toolkit: string }[] };
-};
-
-export type Workflow = {
-  _id: string;
-  deploymentId: string;
-  subdomain: string;
-  name: string;
-  prompt?: string;
-  type?: WorkflowType;
-  trigger: WorkflowTrigger;
-  status: 'active' | 'disabled' | 'deleted';
-  automerge?: boolean;
-  context?: WorkflowContextItem[];
-  notify?: WorkflowNotify;
-  createdAt: string;
-  updatedAt: string;
-  lastRanAt?: string;
-};

package/tsconfig.build.json

@@ -1,4 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "include": ["src/**/*.ts"]
-}

package/tsconfig.json

@@ -1,10 +0,0 @@
-{
-  "extends": "@mintlify/ts-config",
-  "compilerOptions": {
-    "outDir": "bin",
-    "types": ["vitest/globals"],
-    "jsx": "react-jsx"
-  },
-  "include": ["**/*.ts", "src/**/*.tsx"],
-  "exclude": ["node_modules", "bin"]
-}

package/vitest.config.ts

@@ -1,9 +0,0 @@
-import { defineConfig } from 'vitest/config';
-
-export default defineConfig({
-  test: {
-    globals: true,
-    testTimeout: 30000,
-    exclude: ['bin/**', 'node_modules/**'],
-  },
-});