Headless Go client for Obsidian
Home
Getting Started
  • Overview
  • macOS
  • Linux
  • Windows
  • Docker
  • From Source
  • Overview
  • Authentication
  • Sync
  • Publish
  • Configuration
  • Overview
  • Sync Protocol
  • Encryption
  • REST API
  • Circuit Breaker
GitHub
Home
Getting Started
  • Overview
  • macOS
  • Linux
  • Windows
  • Docker
  • From Source
  • Overview
  • Authentication
  • Sync
  • Publish
  • Configuration
  • Overview
  • Sync Protocol
  • Encryption
  • REST API
  • Circuit Breaker
GitHub
  • Usage
  • Authentication
  • Sync
  • Publish
  • Configuration

Publish

ob publish-list-sites

List publish sites associated with the logged-in account.

ob publish-list-sites

ob publish-create-site

Create a publish site.

ob publish-create-site --slug <slug>
FlagDescription
--slugSite slug (required)

ob publish-setup

Attach a vault to a publish site.

ob publish-setup --site <site> [--path <path>]
FlagDefaultDescription
--site(required)Site ID or slug
--path.Local vault path

ob publish-config

View or update publish settings for a configured site.

ob publish-config [--path <path>] [--includes <patterns>] [--excludes <patterns>]
FlagDefaultDescription
--path.Local vault path
--includesComma-separated include patterns
--excludesComma-separated exclude patterns

When called without any update flags, displays the current configuration.

ob publish-unlink

Remove local publish configuration for a site.

ob publish-unlink [--path <path>]
FlagDefaultDescription
--path.Local vault path

ob publish

Publish vault changes to the configured site.

ob publish [--path <path>] [--dry-run] [--yes] [--all]
FlagDefaultDescription
--path.Local vault path
--dry-runfalseShow changes without publishing
--yesfalseApply changes without confirmation
--allfalsePublish untagged files too
Edit this page on GitHub
Last Updated: 5/1/26, 8:35 PM
Contributors: Belphemur
Prev
Sync
Next
Configuration