docmost-cli

A command-line tool for managing Docmost wiki instances from the terminal.

Features

• Page CRUD -- create, read, update, and delete wiki pages with Markdown content
• Space management -- list, create, and update workspaces
• Comments -- add, edit, and list comments on any page
• Full-text search -- search across pages and attachments
• ProseMirror conversion -- automatic conversion between Docmost's ProseMirror JSON and Markdown
• Tree view -- display page hierarchies as indented trees
• Configuration profiles -- manage multiple Docmost instances with named profiles
• Edition-agnostic -- works with both Docmost Enterprise (API key) and Community (email/password)
• Unix-friendly output -- data to stdout, messages to stderr; every command is pipeable

Installation

From PyPI (recommended)

pip install docmost-cli

With pipx (isolated environment)

pipx install docmost-cli

From source

git clone https://github.com/glinhard/docmost-cli.git
cd docmost-cli
uv pip install -e .

Quick Start

# 1. Set up your configuration (interactive wizard)
docmost-cli config init

# 2. Test connectivity and authentication
docmost-cli config test

# 3. List all spaces
docmost-cli space list

# 4. Get a page as Markdown
docmost-cli page get <page-id>

# 5. Create a new page from a Markdown file
docmost-cli page create <space-slug> --title "My Page" --file content.md

Command Reference

Pagination

Every list command follows pagination automatically and shares the same flags:

# Every page in the space, not just the server's first page
docmost-cli page list eng --json | jq 'length'

# Drive the cursor yourself
docmost-cli page list eng --no-follow --json --envelope | jq -r .meta.nextCursor

# --json is lossless; narrow it with --fields when you only need a few keys
docmost-cli page list eng --json --fields id,title,updatedAt | jq -r '.[] | [.id,.title] | @tsv'

Configuration

Config file location

~/.config/docmost-cli/config.toml

Override with --config /path/to/config.toml on any command.

Profiles

The config file supports multiple named profiles for managing different Docmost instances:

[default]
url = "https://docs.example.com"
api_key = "dm_xxxxxxxxxxxxxxxxxxxx"

[staging]
url = "https://staging-docs.example.com"
api_key = "dm_yyyyyyyyyyyyyyyyyyyy"

Switch profiles with --profile or -p:

docmost-cli --profile staging space list

Environment variables

All configuration values can be overridden via environment variables:

Environment variables take precedence over config file values.

Authentication

Enterprise edition (API key)

Use an API key for authentication. Set it in the config file or via DOCMOST_API_KEY:

docmost-cli config set api_key "dm_xxxxxxxxxxxxxxxxxxxx"

Community edition (email/password)

Use email and password for session-based authentication:

docmost-cli config set email "user@example.com"
docmost-cli config set password "secret"

The CLI automatically detects which auth method to use: if api_key is present it uses token auth, otherwise it falls back to email/password session auth.

Tab Completion

Enable shell tab completion for all commands and options:

docmost-cli --install-completion

Supports bash, zsh, fish, and PowerShell.

Development

# Clone and install in development mode
git clone https://github.com/glinhard/docmost-cli.git
cd docmost-cli
uv pip install -e ".[dev]"

# Run tests
pytest

# Run tests with coverage
pytest --cov=docmost_cli

# Linting and formatting
ruff check src/ tests/
ruff format src/ tests/

# Type checking
mypy src/

Acknowledgments

This CLI is a third-party tool for Docmost, an open-source collaborative wiki and documentation platform — an alternative to Confluence and Notion. Docmost is created by @Philipinho and contributors, licensed under AGPL-3.0.

License

AGPL-3.0. See LICENSE for details.