Meldoc CLI

Your documentation lives in Git, right next to your code. Meldoc CLI syncs .meldoc.md files between your local repository and the Meldoc server — edit locally, push to publish, pull to stay current.

How it works

You write documentation as .meldoc.md files in your repo. The CLI detects changes with meldoc scan, uploads them with meldoc push, and downloads the latest with meldoc pull. Your docs stay in version control, go through code reviews, and publish from CI/CD pipelines.

The CLI requires a Git repository and an Integration Tokens — either meldoc auth login or an integration token.

In this section

Setup

Installation — Install, update, and verify the CLI.

Quick Start — Get your first document published in minutes.

Configuration — Config file, frontmatter, and environment variables.

Frontmatter Parameters — Every key a document’s frontmatter may carry.

Several Projects in One Repository — Several Meldoc projects in one repository.

Importing existing documentation — Bring documentation that already exists into Meldoc.

Usage

Command Reference — Full reference for every CLI command.

Workflow — Push, pull, and daily sync workflows.

Working with Assets — Manage images and files in your documents.

Document Templates — Browse the project’s templates and the template: key.

Conflict Resolution — Handle sync conflicts when local and server edits collide.

Team Workflow — Collaborate on documentation with your team.

CI/CD Integration — Publish docs automatically from CI/CD pipelines.

Renaming Aliases — Rename an alias without breaking the links to it.

Advanced Usage — Automation, debugging, and security.

Help

Troubleshooting — Common issues and fixes.