Quick Start Guide

Get Started with Marco CLI

From installation to publishing your first documentation in under 7 minutes ⚡️

5 simple steps
7 minutes
Zero config
1

Installation

Get Marco CLI installed on your system in seconds 🚀

macOS/Linux:

curl -L https://cdn.marcodocs.com/install.sh | bash

Windows:

Download the latest .exe from our downloads page and add it to your PATH.

Verify installation:

marco --version
2

Setup

Connect to MarcoDocs and publish your first documentation ⚡️

1. Get your API token

Sign in to your MarcoDocs dashboard and generate an API token under Settings → API Tokens.

2. Authenticate Marco CLI

marco auth login

Enter your API token when prompted.

3. Initialize your project

cd your-project
marco docs init

Answer a few questions about your project to set up the configuration.

4. Publish your docs

marco docs publish

Your documentation is now live on MarcoDocs! 🎉

3

Publish API Specs

Transform your OpenAPI specifications into beautiful, interactive documentation 📚

Publish your OpenAPI specification

marco spec publish openapi.yaml

Marco CLI automatically processes your OpenAPI spec and creates interactive documentation with try-it-out features.

4

Customize Your Services

Add metadata, tags, and links to organize and enhance your documentation 🎨

Enhance with metadata and links

Create a marco.yaml file to customize any service with additional metadata:

service: Your Service Name
slug: your-service-slug  
description: A comprehensive description of your service
tags:
    - documentation
    - api
    - backend
links:
    - title: GitHub Repository
      href: https://github.com/yourusername/your-project
      description: Source code repository
    - title: Live Demo
      href: https://demo.yourdomain.com
      description: Interactive demo
    - title: API Documentation
      href: https://api.yourdomain.com/docs
      description: Detailed API reference
config:
    docsFolder: docs
    readmePath: README.md

Customization Benefits

  • Tags: Categorize services for easy discovery and filtering
  • Links: Connect to related resources like GitHub, demos, or live APIs
  • Config: Specify documentation folders and README paths
  • Metadata: Add rich descriptions and custom slugs
5

Success & Next Steps

🎉 You're all set! Your documentation workflow is ready. Here's what you can do next:

Ready to explore more?

Connect with the community and discover advanced features

Join our Community

Connect with other developers, share tips, and get help when you need it.

Join Discord Community →

Explore

Visit the MarcoDocs dashboard to explore your documentation.

Visit Dashboard →

Ready to get started?

Download Marco CLI and start publishing beautiful documentation today.

Download Marco CLI