@dirigible/cli

Command-line interface for Dirigible — notes, albums, music, documents, and publishing.

Install

npm install -g @dirigible/cli

Quick Start

# Sign in with your API token
dg login --token dg_xxxxxxxxxxxxxxxxxxxx

# List your notes
dg notes list

# Create a note
dg notes create "My Note" --content "# Hello World"

# Search notes
dg notes search "meeting"

Commands

| Command | Description | |---------|-------------| | dg notes | Manage notes (list, get, create, update, delete, search, add-image) | | dg folders | Manage folders (list, create, rename, delete) | | dg albums | Manage albums — add-image, remove-image, download, delete | | dg music | Manage music libraries — add, delete, download songs | | dg tags | Manage tags (list, add, remove, find) | | dg publish | Manage published sites — create, config, themes, deploy, publish/unpublish notes | | dg documents | Manage documents — upload, download, delete | | dg tokens | Manage API tokens (list, create, revoke) | | dg login | Sign in with an API token | | dg logout | Sign out | | dg whoami | Show current user | | dg status | Show connection status |

Run dg <command> --help for detailed usage.

Publishing

# Create a site from a folder
dg publish create <folder-id> --mode blog --slug my-blog

# Configure theme, fonts, and custom CSS
dg publish config <site-id> --theme serif --body-font "Georgia"
dg publish config <site-id> --custom-css @./styles.css
dg publish config <site-id> --custom-domain blog.example.com

# Configure blog appearance
dg publish config <site-id> --banner-image "https://..." --blurb "Welcome to my blog"
dg publish config <site-id> --post-display cards --pinned-note <note-id>
dg publish config <site-id> --custom-footer "Made with love" --favicon "https://..."

# Hide footer or restore default
dg publish config <site-id> --no-footer
dg publish config <site-id> --show-footer

# Set per-note thumbnail and blurb
dg notes update <note-id> --thumbnail "https://..." --blurb "A short excerpt"

# List available themes
dg publish themes

# Deploy to CDN
dg publish deploy <site-id>

Note Images

# Attach images to a note
dg notes add-image <note-id> photo.jpg diagram.png

Output Formats

All commands support --json for machine-readable output. Some commands also support --html and --meta.

Pagination

List commands support --limit <n> to paginate results.

Documentation

• CLI Documentation
• API Reference

License

MIT