@mintlify/cli 4.0.1812 → 4.1.1

package/bin/welcome.js

@@ -1,108 +0,0 @@
-import chalk from 'chalk';
-const MINT_GREEN = '#18E299';
-const mint = chalk.hex(MINT_GREEN);
-const GROUPS = [
-    {
-        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 = [
-    { 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, description, nameWidth, indent) => ' '.repeat(indent) + mint(name.padEnd(nameWidth)) + chalk.dim(description);
-/**
- * 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, }) {
-    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 = [
-        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 = [''];
-    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/bin/workflows/client.js

@@ -1,34 +0,0 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-import { authenticatedFetch } from '../authenticatedFetch.js';
-import { API_URL } from '../constants.js';
-function request(path, init) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const res = yield authenticatedFetch(`${API_URL}/api/cli/workflows${path}`, Object.assign(Object.assign({}, init), { headers: Object.assign({ Accept: 'application/json' }, init === null || init === void 0 ? void 0 : init.headers) }));
-        if (!res.ok) {
-            const body = yield res.text().catch(() => '');
-            throw new Error(`API error (${res.status}): ${body || res.statusText}`);
-        }
-        return res.json();
-    });
-}
-export function createWorkflow(subdomain, body) {
-    return request(`/${encodeURIComponent(subdomain)}`, {
-        method: 'POST',
-        headers: { 'Content-Type': 'application/json' },
-        body: JSON.stringify(body),
-    });
-}
-export function listWorkflows(subdomain) {
-    return request(`/${encodeURIComponent(subdomain)}`);
-}
-export function deleteWorkflow(subdomain, workflowSchemaId) {
-    return request(`/${encodeURIComponent(subdomain)}/${encodeURIComponent(workflowSchemaId)}`, { method: 'DELETE' });
-}

package/bin/workflows/index.js

@@ -1,269 +0,0 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-import { jsx as _jsx } from "react/jsx-runtime";
-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 { 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, } from './types.js';
-function resolveFormat(argv) {
-    return argv.format === 'json' ? 'json' : 'table';
-}
-function output(format, text) {
-    if (format === 'table') {
-        addLog(_jsx(Text, { children: text }));
-    }
-    else {
-        process.stdout.write(text + '\n');
-    }
-}
-function requireSubdomain(subdomain) {
-    if (!subdomain) {
-        throw new Error('No subdomain set. Pass --subdomain, or run `mint config set subdomain <name>`.');
-    }
-    return subdomain;
-}
-function readWorkflowFile(filePath) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const resolved = path.isAbsolute(filePath) ? filePath : path.join(CMD_EXEC_PATH, filePath);
-        const contents = yield fs.readFile(resolved, 'utf-8');
-        if (/\.ya?ml$/i.test(resolved))
-            return yaml.load(contents);
-        return JSON.parse(contents);
-    });
-}
-function buildTriggerFromFlags(argv) {
-    var _a;
-    const repos = ((_a = argv.pushRepo) !== null && _a !== void 0 ? _a : []).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) {
-    var _a;
-    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)) {
-        throw new Error(`Invalid --type "${type}". Valid types: ${WORKFLOW_TYPES.join(', ')}`);
-    }
-    const body = {
-        name: argv.name,
-        on: buildTriggerFromFlags(argv),
-    };
-    if (argv.prompt)
-        body.prompt = argv.prompt;
-    if (type)
-        body.type = type;
-    if (argv.automerge !== undefined)
-        body.automerge = argv.automerge;
-    const contextRepos = ((_a = argv.contextRepo) !== null && _a !== void 0 ? _a : []).map(String).filter(Boolean);
-    if (contextRepos.length > 0)
-        body.context = contextRepos.map((repo) => ({ repo }));
-    return body;
-}
-function describeTrigger(trigger) {
-    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) {
-    const lines = [];
-    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) {
-    if (workflows.length === 0)
-        return 'No automations found.';
-    const rows = workflows.map((w) => {
-        var _a;
-        return [
-            w._id,
-            w.name,
-            (_a = w.type) !== null && _a !== void 0 ? _a : '—',
-            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) => cells.map((c, i) => c.padEnd(widths[i])).join('  ');
-    return [chalk.bold(fmt(headers)), ...rows.map(fmt)].join('\n');
-}
-const withSubdomain = (yargs) => yargs.option('subdomain', {
-    type: 'string',
-    description: 'Documentation subdomain (default: mint config set subdomain)',
-});
-const withFormat = (yargs) => yargs.option('format', {
-    type: 'string',
-    choices: ['table', 'json'],
-    description: 'Output format (table=pretty, json=raw)',
-});
-export const workflowsBuilder = (yargs) => 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', ''), (argv) => __awaiter(void 0, void 0, void 0, function* () {
-    const format = resolveFormat(argv);
-    try {
-        const subdomain = requireSubdomain(argv.subdomain);
-        const body = argv.file
-            ? (yield readWorkflowFile(argv.file))
-            : buildBodyFromFlags(argv);
-        if (format === 'table')
-            addLog(_jsx(SpinnerLog, { message: "Creating automation..." }));
-        const created = yield 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(_jsx(SuccessLog, { message: `Created automation ${created._id}` }));
-            output(format, renderWorkflow(created));
-        }
-        yield 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(_jsx(ErrorLog, { message: message }));
-        }
-        yield terminate(1);
-    }
-}))
-    .command('list', 'List automations for the current deployment', (yargs) => withFormat(withSubdomain(yargs)), (argv) => __awaiter(void 0, void 0, void 0, function* () {
-    const format = resolveFormat(argv);
-    try {
-        const subdomain = requireSubdomain(argv.subdomain);
-        if (format === 'table')
-            addLog(_jsx(SpinnerLog, { message: "Fetching automations..." }));
-        const workflows = yield listWorkflows(subdomain);
-        if (format === 'table')
-            removeLastLog();
-        if (format === 'json') {
-            output(format, JSON.stringify(workflows, null, 2));
-        }
-        else {
-            output(format, renderList(workflows));
-        }
-        yield 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(_jsx(ErrorLog, { message: message }));
-        }
-        yield terminate(1);
-    }
-}))
-    .command('delete <id>', 'Delete an automation by ID', (yargs) => withFormat(withSubdomain(yargs)).positional('id', {
-    type: 'string',
-    demandOption: true,
-    description: 'Automation schema ID',
-}), (argv) => __awaiter(void 0, void 0, void 0, function* () {
-    const format = resolveFormat(argv);
-    try {
-        const subdomain = requireSubdomain(argv.subdomain);
-        if (format === 'table')
-            addLog(_jsx(SpinnerLog, { message: "Deleting automation..." }));
-        yield deleteWorkflow(subdomain, argv.id);
-        if (format === 'table')
-            removeLastLog();
-        if (format === 'json') {
-            output(format, JSON.stringify({ success: true, id: argv.id }, null, 2));
-        }
-        else {
-            addLog(_jsx(SuccessLog, { message: `Deleted automation ${argv.id}` }));
-        }
-        yield 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(_jsx(ErrorLog, { message: message }));
-        }
-        yield terminate(1);
-    }
-}))
-    .demandCommand(1, 'specify a subcommand: create, list, or delete');

package/bin/workflows/types.js

@@ -1,11 +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',
-];

package/scripts/bundle-converter.mjs

@@ -1,26 +0,0 @@
-import { build } from 'esbuild';
-import { createRequire } from 'node:module';
-
-const require = createRequire(import.meta.url);
-const entry = require.resolve('@mintlify/editor/converter');
-
-await build({
-  entryPoints: [entry],
-  outfile: 'bin/vendor/converter.js',
-  bundle: true,
-  format: 'esm',
-  platform: 'node',
-  target: 'node18',
-  external: [
-    '@mintlify/common',
-    '@mintlify/validation',
-    'js-yaml',
-    'mdast-util-*',
-    'prosemirror-*',
-    'remark*',
-    'unified',
-    'unist-util-*',
-    'yaml',
-    'zod',
-  ],
-});

package/scripts/generate-logo.mjs

@@ -1,79 +0,0 @@
-// Regenerates `src/logo.ts` — the ASCII Mintlify leaf shown on the welcome
-// screen.
-//
-// Pipeline: flatten the icon's three vector paths into one solid-white
-// silhouette (so brightness-based renderers don't drop the darker leaf
-// segments), rasterize it with `sharp`, let `chafa` do the image -> ASCII shape
-// detection, then normalize every glyph to a solid `#` for the clean
-// single-color mark.
-//
-// Usage:  node scripts/generate-logo.mjs
-// Requires `sharp` (a monorepo dependency) and the `chafa` CLI on PATH.
-
-import { execFileSync } from 'node:child_process';
-import { mkdtempSync, writeFileSync } from 'node:fs';
-import { tmpdir } from 'node:os';
-import { dirname, join } from 'node:path';
-import { fileURLToPath } from 'node:url';
-import sharp from 'sharp';
-
-const MINT_GREEN = '#18E299';
-const MINT_GREEN_DEEP = '#0C8C5E';
-
-// Paths from mintlify-icon.svg (viewBox 0 0 19 19), all filled solid white over
-// a black background so chafa sees one uniform-brightness silhouette.
-const PATHS = [
-  'M18.367 7.28888V1.59755C18.367 0.986819 17.8715 0.5 17.2699 0.5H11.5812C10.6877 0.5 9.80295 0.677018 8.98017 1.01336C8.15738 1.35856 7.40539 1.85424 6.77724 2.49152L6.733 2.53578C5.90137 3.37664 5.30862 4.42108 5.00781 5.57174C5.54749 5.43012 6.10483 5.35931 6.6622 5.35046C8.14852 5.33276 9.60831 5.81073 10.7938 6.7047C11.8643 7.50131 12.6783 8.59885 13.1206 9.86458C13.5807 11.148 13.6337 12.5465 13.2887 13.8653C14.43 13.5644 15.4828 12.9714 16.3233 12.1393L16.3675 12.0951C16.9957 11.4667 17.4999 10.7143 17.845 9.89114C18.19 9.06797 18.3581 8.18285 18.3581 7.28888H18.367Z',
-  'M4.83793 7.193C4.84674 5.44706 5.54303 3.77167 6.76814 2.51953L2.03511 7.25472C2.01749 7.27236 1.99985 7.28117 1.98222 7.29881C0.827615 8.44513 0.131342 9.97945 0.0167623 11.6019C-0.0890033 13.1186 0.307609 14.6176 1.15373 15.8698C1.23444 15.9892 1.45343 16.0285 1.57682 15.9139L4.47656 13.0216C5.38438 12.1134 5.66643 10.7642 5.23455 9.55618C4.96132 8.80666 4.82912 8.00424 4.83793 7.193Z',
-  'M16.341 12.0938C15.4332 12.9844 14.2962 13.6016 13.0623 13.875C11.8195 14.1483 10.5327 14.0689 9.33405 13.6457C9.33405 13.6457 9.32522 13.6457 9.31641 13.6457C8.10892 13.2136 6.76042 13.4958 5.8526 14.3952L2.95282 17.2875C2.82943 17.4109 2.84706 17.6137 2.99689 17.7107C4.24845 18.5484 5.74683 18.954 7.26281 18.8482C8.88455 18.7336 10.4093 18.037 11.5639 16.8818L11.608 16.8378L16.341 12.1026V12.0938Z',
-];
-
-const SIZE = '28x14'; // chafa output columns x rows
-const RES = 480; // raster resolution fed to chafa
-
-const silhouette = `<svg width="19" height="19" viewBox="0 0 19 19" xmlns="http://www.w3.org/2000/svg"><rect width="19" height="19" fill="#000"/>${PATHS.map(
-  (d) => `<path d="${d}" fill="#fff"/>`
-).join('')}</svg>`;
-
-const pngPath = join(mkdtempSync(join(tmpdir(), 'mint-logo-')), 'silhouette.png');
-await sharp(Buffer.from(silhouette)).resize(RES, RES, { fit: 'fill' }).png().toFile(pngPath);
-
-const ascii = execFileSync(
-  'chafa',
-  ['--symbols', 'ascii', '-c', 'none', '--dither', 'none', '--size', SIZE, pngPath],
-  { encoding: 'utf8' }
-);
-
-// chafa renders the shape with a brightness ramp of letters; collapse every
-// glyph to `#` for the clean single-color mark, trim trailing space, and drop
-// blank rows at the bottom.
-const art = ascii
-  .split('\n')
-  .map((line) => line.replace(/\S/g, '#').replace(/\s+$/, ''))
-  .filter(
-    (line, index, lines) => line.length > 0 || lines.slice(index).some((rest) => rest.trim())
-  );
-
-const file = `// AUTO-GENERATED by \`scripts/generate-logo.mjs\` from the Mintlify icon mark.
-// Do not edit by hand — run \`node scripts/generate-logo.mjs\` to regenerate.
-
-/** Mintlify brand greens. */
-export const MINT_GREEN = '${MINT_GREEN}';
-export const MINT_GREEN_DEEP = '${MINT_GREEN_DEEP}';
-
-/**
- * The Mintlify leaf, rendered as a solid \`#\` mark (chafa shape detection,
- * normalized to a single glyph). Drawn in {@link MINT_GREEN} on the welcome
- * screen.
- */
-export const MINT_LOGO: string[] = [
-${art.map((line) => `  '${line}',`).join('\n')}
-];
-
-/** Width of the widest logo row, for laying out content beside it. */
-export const MINT_LOGO_WIDTH = MINT_LOGO.reduce((max, line) => Math.max(max, line.length), 0);
-`;
-
-const out = join(dirname(fileURLToPath(import.meta.url)), '..', 'src', 'logo.ts');
-writeFileSync(out, file);
-console.log(`Wrote ${out} (${art.length} rows, width ${Math.max(...art.map((r) => r.length))})`);