CLI Quickstart - Relevate

You do not need an account to use Relevate locally. You can install the CLI, start a preview, and test your docs on your own machine.

Try Relevate Locally

Create a docs folder

Create a new folder for your docs and move into it:

mkdir my-docs
cd my-docs

Install or run the CLI

Pick one option:

```
npx relevate init
```
```
npm install -g relevate
relevate init
```
```
pnpm add -g relevate
relevate init
```
```
bun add -g relevate
relevate init
```

This creates the required files for you.

Start the preview

Run:

relevate preview

The CLI prints a local URL. Open it in your browser.

Edit a page

Open index.mdx and change the text.

---
title: Welcome
description: Start here
---

# Welcome to our docs

This site is running with Relevate.

Save the file. Refresh the page if needed.

Run the accessibility check

Run:

relevate a11y

Use this before you publish. It helps you catch common accessibility issues early.

What Gets Created

After running relevate init, your project looks like this:

docs

docs.json

index.mdx

public

light.svg

dark.svg

favicon.svg

If The Preview Looks Stale

Sometimes a cached build can get out of sync while Relevate is still in beta. If the preview does not reflect your latest changes, clean the project cache and start again.

relevate clean
relevate preview

You usually do not need relevate clean. Use it when the local preview looks stuck, out of date, or otherwise wrong.

Add Another Language

When you are ready, add another language folder:

docs

docs.json

index.mdx

Then enable languages in docs.json:

{
  "navigation": {
    "languages": {
      "default": "en",
      "items": ["en", "jp"]
    },
    "tabs": [
      {
        "id": "docs",
        "label": {
          "en": "Docs",
          "jp": "ドキュメント"
        },
        "content": ["index"]
      }
    ]
  }
}

Next Steps

Getting Started

Learn how to structure the full docs project.

Localization

Add French, Dutch, Japanese, and more.

Config Reference

See the main docs.json fields.