mintlify__docs/install-mintlify-cli.mdx

---
title: "Install Mintlify CLI"
sidebarTitle: "Install Mintlify CLI (beginners)"
description: "A beginner-friendly walkthrough for installing the Mintlify CLI, written in plain language with no technical assumptions."
keywords: ["CLI", "beginner", "non-technical", "install", "mint", "Node.js", "terminal"]
---

This guide walks you through installing the Mintlify CLI step by step. No coding experience required. If you can copy and paste, you can do this.

yup

you

can

edit this 

and change it

<Note>
  The **CLI** (Command Line Interface) is a small program that lets you preview your documentation on your own computer before publishing it online.
</Note>

## What you'll need

Before you start, make sure you have:

- A computer running macOS, Windows, or Linux
- About 15 minutes
- An internet connection

That's it. We'll install everything else together.

## Step 1: Open the Terminal

The Terminal is an app on your computer where you type commands instead of clicking buttons.

<Tabs>
  <Tab title="Mac">
    1. Press `Cmd` \+ `Space` to open Spotlight Search.
    2. Type `Terminal` and press `Enter`.
    3. A black or white window will open. This is your Terminal.
  </Tab>
  <Tab title="Windows">
    1. Press the `Windows` key.
    2. Type `PowerShell` and press `Enter`.
    3. A blue window will open. This is your Terminal.
  </Tab>
  <Tab title="Linux">
    1. Press `Ctrl` \+ `Alt` \+ `T`.
    2. A Terminal window will open.
  </Tab>
</Tabs>

<Tip>
  Don't worry if it looks intimidating. You only need to type (or paste) a few commands.
</Tip>

## Step 2: Install Node.js

Node.js is a free program that the Mintlify CLI needs to run. Think of it like installing the engine before the car.

<Steps>
  <Step title="Check if you already have Node.js">
    In your Terminal, type this command and press `Enter`:

    ```bash
    node --version
    ```

    - If you see something like `v20.17.0` or higher, **skip to Step 3**.
    - If you see `command not found` or a lower version, continue below.
  </Step>
  <Step title="Download Node.js">
    1. Go to [nodejs.org](https://nodejs.org/en).
    2. Click the big green button that says **LTS** (this stands for Long Term Support — the most stable version).
    3. Open the downloaded file and follow the installer prompts. Click **Next** or **Continue** on each screen, accepting the defaults.
  </Step>
  <Step title="Confirm Node.js installed">
    Close your Terminal completely, then reopen it (this refreshes its memory).

    Type the command again:

    ```bash
    node --version
    ```

    You should now see a version number like `v20.17.0`. 🎉
  </Step>
</Steps>

## Step 3: Install the Mintlify CLI

Now you'll install Mintlify itself. Copy and paste this command into your Terminal, then press `Enter`:

```bash
npm i -g mint
```

<Note>
  **What does this mean?**

  - `npm` is the tool that installs programs (it came with Node.js).
  - `i` is short for "install".
  - `-g` means "install it globally" so you can use it from any folder.
  - `mint` is the name of the Mintlify CLI.
</Note>

You'll see some text scroll by. Wait until you see your cursor blinking on a new empty line again. That means it's done.

<Warning>
  **Seeing a "permission denied" error on Mac or Linux?** Try this instead:

  ```bash
  sudo npm i -g mint
  ```

  It will ask for your computer's password. Type it (you won't see the characters appear — that's normal) and press `Enter`.
</Warning>

## Step 4: Confirm it worked

Type this command and press `Enter`:

```bash
mint version
```

If you see a version number, you're done! The CLI is installed. 🎉

## Step 5: Preview your docs

If you already have a docs folder on your computer:

<Steps>
  <Step title="Navigate to your docs folder">
    In the Terminal, type `cd ` (with a space after it), then drag your docs folder from your file browser into the Terminal window. Press `Enter`.
  </Step>
  <Step title="Start the preview">
    Type:

    ```bash
    mint dev
    ```

    Your browser will open automatically to `http://localhost:3000` showing your documentation.
  </Step>
  <Step title="Stop the preview">
    When you're done, go back to the Terminal and press `Ctrl` \+ `C` to stop the preview.
  </Step>
</Steps>

## Common questions

<AccordionGroup>
  <Accordion title="What if I close my Terminal? Do I have to reinstall?">
    No. Once installed, the CLI stays on your computer. Just open the Terminal again whenever you want to use it.
  </Accordion>

  <Accordion title="How do I update the CLI later?">
    Run this command anytime:

    ```bash
    mint update
    ```
  </Accordion>

  <Accordion title="I'm stuck. Where can I get help?">
    - Check the [main installation guide](/installation) for technical details.
    - Ask in the [Mintlify community](https://mintlify.com/community).
    - Email support at [support@mintlify.com](mailto:support@mintlify.com).
  </Accordion>
</AccordionGroup>

## Next steps

- [Format text](/create/text) — learn how to write content
- [Quickstart](/quickstart) — make your first change
- [Install the CLI](/installation) — the technical reference version of this guide