@mintlify/cli 4.0.1766 → 4.0.1767

package/bin/welcome.js

@@ -46,6 +46,7 @@ const GROUPS = [
         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' },
         ],
     },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mintlify/cli",
-  "version": "4.0.1766",
+  "version": "4.0.1767",
   "description": "The Mintlify CLI",
   "engines": {
     "node": ">=18.0.0"
@@ -106,5 +106,5 @@
     "vitest": "2.1.9",
     "vitest-mock-process": "1.0.4"
   },
-  "gitHead": "bf1395b413f57803c73a2b5b3383fd4ad7ebb761"
+  "gitHead": "25990bd1c8ce8738dc0b9933a51c0e8b5a543aef"
 }

package/src/cli.tsx

@@ -37,6 +37,7 @@ import {
   terminate,
 } from './helpers.js';
 import { init } from './init.js';
+import { fetchInstructions, formatTopics } from './instructions.js';
 import { getAccessToken } from './keyring.js';
 import { login } from './login.js';
 import { logout } from './logout.js';
@@ -601,6 +602,37 @@ export const cli = ({ packageName = 'mint' }: { packageName?: string }) => {
             .example('mint broken-links --files "guides/**/*.mdx"', 'Check pages matching a glob'),
         (argv) => brokenLinksHandler(argv)
       )
+      .command(
+        'instructions [topics..]',
+        'Print Mintlify workflow instructions for agents',
+        (yargs) =>
+          yargs
+            .positional('topics', {
+              type: 'string',
+              array: true,
+              default: [] as string[],
+              description: 'Topic and optional subtopic',
+            })
+            .example('mint instructions', 'List topics')
+            .example('mint instructions publish domain', 'Custom domain instructions'),
+        async ({ topics }) => {
+          if (topics.length === 0) {
+            process.stdout.write(formatTopics());
+            await terminate(0);
+            return;
+          }
+          let markdown;
+          try {
+            markdown = await fetchInstructions(topics);
+          } catch (error) {
+            addLog(<ErrorLog message={error instanceof Error ? error.message : String(error)} />);
+            await terminate(1);
+            return;
+          }
+          await new Promise<void>((resolve) => process.stdout.write(markdown, () => resolve()));
+          await terminate(0);
+        }
+      )
       .command(
         'status',
         'View current authentication status',

package/src/instructions.ts

@@ -0,0 +1,99 @@
+export const INSTRUCTIONS_URL = 'https://www.mintlify.com/docs/mint-instructions';
+
+export const TOPICS: { name: string; when: string }[] = [
+  {
+    name: 'overview',
+    when: 'Start here: how Mintlify works and facts agents most often get wrong',
+  },
+  {
+    name: 'new-site',
+    when: 'New docs site, first publish, no account, claim a site, login, no docs.json yet',
+  },
+  {
+    name: 'write',
+    when: 'Before creating a page or writing more than a sentence or two; changelogs',
+  },
+  {
+    name: 'write components',
+    when: 'Adding or changing components: callouts, cards, steps, tabs, accordions, fields',
+  },
+  { name: 'configure', when: 'Changing docs.json: theme, colors, logo, favicon, required fields' },
+  {
+    name: 'configure navigation',
+    when: 'Changing navigation: groups, tabs, anchors, dropdowns, products, versions, languages',
+  },
+  {
+    name: 'configure settings',
+    when: 'navbar, footer, banner, SEO, search, integrations, contextual menu, redirects, 404',
+  },
+  {
+    name: 'configure customization',
+    when: 'Themes, fonts, CSS, JavaScript, or React snippets',
+  },
+  { name: 'api-docs', when: 'API documentation: OpenAPI, AsyncAPI, GraphQL, playground' },
+  {
+    name: 'api-docs sdk',
+    when: 'SDK reference pages, x-codeSamples, oneOf/anyOf, multiple responses, hiding endpoints',
+  },
+  {
+    name: 'publish',
+    when: 'Deploying, "is it live", previews, rollbacks, MCP, llms.txt, skill.md, Markdown export',
+  },
+  {
+    name: 'publish domain',
+    when: 'Custom domain (mint add-domain), /docs subpath, reverse proxy, CSP',
+  },
+  {
+    name: 'publish repo',
+    when: 'Monorepo, multi-repo, GitHub/GitLab/Bitbucket, offline export, self-host',
+  },
+  {
+    name: 'publish analytics',
+    when: 'mint analytics, feedback, search data, analytics integrations',
+  },
+  {
+    name: 'publish assistant',
+    when: 'AI assistant, widget, Assistant.md, skills, narration, own model',
+  },
+  { name: 'access', when: 'Private docs, reader login, user groups, personalization' },
+  { name: 'access team', when: 'Team members, roles, SSO, SCIM, audit logs, session security' },
+  {
+    name: 'automate',
+    when: 'Keep docs in sync with code: agent, Autopilot, automations, Slack, CI',
+  },
+  {
+    name: 'migrate',
+    when: 'Moving docs from Docusaurus, GitBook, ReadMe, Fern, Document360, Confluence, Markdown',
+  },
+  { name: 'troubleshoot', when: 'An error, a failed build or deploy, or the site looks wrong' },
+];
+
+export const formatTopics = (): string => {
+  const width = Math.max(...TOPICS.map(({ name }) => name.length)) + 2;
+  return [
+    'Usage: mint instructions <topic> [subtopic]',
+    '',
+    ...TOPICS.map(({ name, when }) => `  ${name.padEnd(width)}${when}`),
+    '',
+  ].join('\n');
+};
+
+export const instructionsUrl = (topics: string[]): string =>
+  `${INSTRUCTIONS_URL}/${topics.map(encodeURIComponent).join('/')}.md`;
+
+export const stripDocsPreamble = (markdown: string): string =>
+  markdown.replace(/^(?:>.*\n|\s*\n)*/, '');
+
+export async function fetchInstructions(topics: string[]): Promise<string> {
+  const url = instructionsUrl(topics);
+  const response = await fetch(url);
+  if (response.status === 404) {
+    throw new Error(
+      `no instructions for "${topics.join(' ')}". Run \`mint instructions\` to list topics.`
+    );
+  }
+  if (!response.ok) {
+    throw new Error(`failed to fetch ${url}: ${response.status} ${response.statusText}`);
+  }
+  return stripDocsPreamble(await response.text());
+}

package/src/welcome.ts

@@ -59,6 +59,7 @@ const GROUPS: CommandGroup[] = [
     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' },
     ],
   },