Use mint CLI

Author: handotdev

.github/workflows/check-links.yml

@@ -13,6 +13,6 @@ jobs:
         with:
           node-version: "latest"
       - name: Install Mintlify CLI
-        run: npm i -g mintlify
+        run: npm i -g mint
       - name: Run broken link checker
-        run: mintlify broken-links
+        run: mint broken-links

api-playground/openapi/setup.mdx

@@ -9,7 +9,7 @@ To describe your endpoints with OpenAPI, make sure you have a valid OpenAPI
 document in either JSON or YAML format that follows the
 [OpenAPI specification](https://swagger.io/specification/). Your document must
 follow OpenAPI specification 3.0+. 
-<Tip>To validate your OpenAPI spec, use our [CLI](https://www.npmjs.com/package/mintlify) and run this command: <br/>`mintlify openapi-check <openapiFilenameOrUrl>`</Tip>
+<Tip>To validate your OpenAPI spec, use our [CLI](https://www.npmjs.com/package/mint) and run this command: <br/>`mint openapi-check <openapiFilenameOrUrl>`</Tip>
 
 ## Auto-populate API pages
 

api-playground/troubleshooting.mdx

@@ -12,7 +12,7 @@ Here's a list of common issues we've seen customers run into:
     In this scenario, it's likely that either Mintlify cannot find your OpenAPI document,
     or your OpenAPI document is invalid.
 
-    Running `mintlify dev` locally should reveal some of these issues.
+    Running `mint dev` locally should reveal some of these issues.
 
     To verify your OpenAPI document will pass validation:
 

changelog.mdx

@@ -86,13 +86,13 @@ mode: "center"
   1. Make sure your CLI is the latest version
 
   ```
-  npm i mintlify@latest -g
+  npm i mint@latest -g
   ```
 
   1. In your docs repository, run
 
   ```
-  mintlify upgrade
+  mint upgrade
   ```
 
   1. Delete your old mint.json file and push your changes

installation.mdx

@@ -17,48 +17,48 @@ icon: "terminal"
   **Prerequisite**: Please install [Node.js](https://nodejs.org/en) (version 19 or higher) before proceeding.
 </Info>
 
-**Step 1**: Install the Mintlify CLI:
+**Step 1**: Install the Mint CLI:
 
 <CodeGroup>
 
 ```bash npm
-npm i -g mintlify
+npm i -g mint
 ```
 
 
 ```bash yarn
-yarn global add mintlify
+yarn global add mint
 ```
 
 
 ```bash pnpm
-pnpm add -g mintlify
+pnpm add -g mint
 ```
 
 </CodeGroup>
 
 **Step 2**: Navigate to the docs directory (where the `docs.json` file is located) and execute the following command:
 
 ```bash
-mintlify dev
+mint dev
 ```
 
 Alternatively, if you do not want to install the CLI globally, you can use a run a one-time script:
 
 <CodeGroup>
 
 ```bash npm
-npx mintlify dev
+npx mint dev
 ```
 
 
 ```bash yarn
-yarn dlx mintlify dev
+yarn dlx mint dev
 ```
 
 
 ```bash pnpm
-pnpm dlx mintlify dev
+pnpm dlx mint dev
 ```
 
 </CodeGroup>
@@ -67,22 +67,22 @@ A local preview of your documentation will be available at `http://localhost:300
 
 ## Updates
 
-Each CLI release is associated with a specific version of Mintlify. If your local preview doesn't align with the production version, please update the CLI:
+Each CLI release is associated with a specific version of the Mintlify platform. If your local preview doesn't align with the production version, please update the CLI:
 
 <CodeGroup>
 
 ```bash npm
-npm i -g mintlify@latest
+npm i -g mint@latest
 ```
 
 
 ```bash yarn
-yarn global upgrade mintlify
+yarn global upgrade mint
 ```
 
 
 ```bash pnpm
-pnpm up --global mintlify
+pnpm up --global mint
 ```
 
 </CodeGroup>
@@ -92,7 +92,7 @@ pnpm up --global mintlify
 By default, the CLI uses port 3000. You can customize the port using the `--port` flag. To run the CLI on port 3333, for instance, use this command:
 
 ```bash
-mintlify dev --port 3333
+mint dev --port 3333
 ```
 
 If you attempt to run on a port that's already in use, it will use the next available port:
@@ -103,22 +103,22 @@ Port 3000 is already in use. Trying 3001 instead.
 
 ## Additional Commands
 
-While `mintlify dev` is the most commonly used command, there are other commands you can use to manage your documentation.
+While `mint dev` is the most commonly used command, there are other commands you can use to manage your documentation.
 
 ### Find Broken Links
 
 The CLI can assist with validating reference links made in your documentation. To identify any broken links, use the following command:
 
 ```bash
-mintlify broken-links
+mint broken-links
 ```
 
 ### Check OpenAPI Spec
 
 You can use the CLI to check your OpenAPI file for errors using the following command:
 
 ```bash
-mintlify openapi-check <openapiFilenameOrUrl>
+mint openapi-check <openapiFilenameOrUrl>
 ```
 
 You can pass in a filename (e.g. `./openapi.yaml`) or a URL (e.g. `https://petstore3.swagger.io/api/v3/openapi.json`).
@@ -128,7 +128,7 @@ You can pass in a filename (e.g. `./openapi.yaml`) or a URL (e.g. `https://petst
 You can rename files using the following command:
 
 ```bash
-mintlify rename <oldFilename> <newFilename>
+mint rename <oldFilename> <newFilename>
 ```
 
 This is an improvement over updating the filename normally as it will also update all references to the file, ensuring no broken links.
@@ -147,11 +147,11 @@ If you use JetBrains, we recommend the [MDX IntelliJ IDEA plugin](https://plugin
   <Accordion title='Error: Could not load the "sharp" module using the darwin-arm64 runtime'>
     This may be due to an outdated version of node. Try the following:
 
-    1. Remove the currently-installed version of mintlify: `npm remove -g mintlify`
+    1. Remove the currently-installed version of the mint CLI: `npm remove -g mint`
     2. Upgrade to Node v19 or higher.
-    3. Reinstall mintlify: `npm install -g mintlify`
+    3. Reinstall the mint CLI: `npm install -g mint`
   </Accordion>
   <Accordion title="Issue: Encountering an unknown error">
-    Solution: Go to the root of your device and delete the ~/.mintlify folder. Afterwards, run `mintlify dev` again.
+    Solution: Go to the root of your device and delete the ~/.mintlify folder. Afterwards, run `mint dev` again.
   </Accordion>
 </AccordionGroup>

pages.mdx

@@ -133,7 +133,7 @@ in any page.
 ```jsx
 ---
 title: "Page that goes to external link"
-url: "https://www.npmjs.com/package/mintlify"
+url: "https://www.npmjs.com/package/mint"
 ---
 ```
 

quickstart.mdx

@@ -54,17 +54,17 @@ To work locally with your documentation, install the Mintlify Command Line Inter
 <CodeGroup>
 
 ```bash npm
-npm install -g mintlify
+npm install -g mint
 ```
 
 
 ```bash yarn
-yarn global add mintlify
+yarn global add mint
 ```
 
 
 ```bash pnpm
-pnpm add -g mintlify
+pnpm add -g mint
 ```
 
 </CodeGroup>
@@ -117,7 +117,7 @@ description: "This is the introduction to the documentation"
 To preview the changes locally, run the following command.
 
 ```bash
-mintlify dev
+mint dev
 ```
 
 Your preview will be available at `localhost:3000`.
@@ -227,7 +227,7 @@ If you encounter any issues during the setup process, check our common troublesh
 
 <AccordionGroup>
   <Accordion title="Local preview not working">
-    Make sure you have Node.js v19+ installed and that you're running the `mintlify dev` command from the directory containing your `docs.json` file.
+    Make sure you have Node.js v19+ installed and that you're running the `mint dev` command from the directory containing your `docs.json` file.
   </Accordion>
   <Accordion title="Changes not reflecting on live site">
     Deployment can take upwards to a few minutes. Check your GitHub Actions (for code-based workflow) or deployment logs in the Mintlify dashboard to ensure there are no build errors.

settings/broken-links.mdx

@@ -11,7 +11,7 @@ When you change the path of a file in your docs folder, it will also change the
 Catch broken links with our CLI. Simply [install the CLI](/installation) and run the command:
 
 ```bash
-mintlify broken-links
+mint broken-links
 ```
 
 The CLI will identify any relative links in your docs that don't exist.