Skip to content

outline-cli

outline-cli

The best wiki CLI: push, pull, search, and read Outline wiki documents from your terminal.

Why outline-cli?

  • Stay in your terminal — no context switching to a browser
  • Docs-as-code — version control your wiki content in git
  • CI/CD native — publish docs automatically on every merge
  • Secure by default — credentials stored in OS keyring (OWASP-aligned)

Quick Start

# Install
curl -sL "https://github.com/Breee/outline-cli/releases/latest/download/outline_linux_amd64.tar.gz" | sudo tar xz -C /usr/local/bin outline

# Authenticate
export OUTLINE_SERVER_URL=https://outline.example.com
export OUTLINE_API_TOKEN=sk-your-token

# Push docs
outline push --collection-id "Engineering" --path ./docs/

Features

FeatureDescription
PushPush markdown files or directory trees to Outline
UpsertUpdates existing docs by title, creates if not found
MetadataPer-file collection, title, icon, parent via HTML comments
ImagesAuto-upload local images as attachments
OIDCBrowser login with PKCE + Dynamic Client Registration
KeyringAll credentials in OS keyring (API token, password, OIDC)
ConfigYAML config with config set/get/list commands
CI/CDWorks with env vars only — no config file needed

AI Integration

This documentation is optimized for AI consumption:

  • llms.txt — structured index for LLM discovery
  • llms-full.txt — complete documentation as single file
  • Every page has llmsDescription frontmatter for precise AI context

Next Steps