Quick Start

Get your first document published to Meldoc in under five minutes.

Prerequisites: You’ve Installation and are inside a Git repository — Meldoc needs a .git directory to work out what changed.

Authenticate

Choose one method:

# Interactive login (recommended)
meldoc auth login

# Or set a token as an environment variable
export MELDOC_TOKEN=YOUR_TOKEN

Commands that talk to the server also take a token directly, as in meldoc push --token YOUR_TOKEN.

meldoc auth login finishes in the browser: it prints a URL and an eight-character code like ABCD-EFGH, and you approve the terminal from the page it opens. Two things are easy to trip over — you have to be signed in to Meldoc in that browser already, otherwise the page only offers you a log-in button, and the code is good for ten minutes. If it has expired, or you approved on the wrong account, run the command again for a fresh one.

Initialize your project

Navigate to your Git repository and run:

meldoc init

This creates meldoc.config.yml and adds .meldoc/ to your .gitignore. When prompted, enter your workspace alias (and an optional project alias) — if you signed in with meldoc auth login, the workspace alias tells the CLI which workspace to sync. You can also set them non-interactively with --workspace and --project.

Pull existing documentation

If your project already has documents on the server, download them:

meldoc pull

Create a document

Let the CLI create the file for you:

meldoc new --alias authentication --title "Authentication"

Or write it yourself. Say you’re documenting the DundlerOS API — create a .meldoc.md file with YAML frontmatter:

---
alias: authentication
title: Authentication
---

API keys are issued per workspace. Each key grants read or write
access to the endpoints below.

Keep in mind: title is required. If it’s missing, meldoc validate flags the document and asks you to add one.

Publish

Scan for changes and push to the server:

meldoc scan
meldoc push

Your document is now live on Meldoc.

What’s next?

Workflow — Learn the daily push, pull, and sync workflows.

Configuration — Customize the config file, frontmatter, and environment variables.

Command Reference — Full reference for every CLI command.