Skip to content
OpenPostDocs
GitHubOpen OpenPost
OpenPostDocs
Command-line interface

Command-line interface

Control OpenPost from a shell, script, CI job, or terminal-capable agent.

The openpost CLI controls a running Hosted or self-hosted OpenPost instance. It follows the same workspace permissions and Publication lifecycle as the web app.

Use it when work starts in a terminal. For a long-running JavaScript or TypeScript service, use the SDK. For a visual workflow, use n8n.

Start here

  1. Install, sign in, and choose a workspace
  2. Create and publish content
  3. Run the CLI in scripts and CI
  4. Inspect results and recover failures

Run openpost help or openpost <group> <command> --help when this guide and an installed version differ. The installed help describes that binary.

The CLI stores creation_source: "cli" on Publications it creates. Publication responses expose that source alongside web, API, SDK, MCP, and automatic posting sources.

Need a hand?TroubleshootingReport an issue

Revisions, retries, and jobs

Prevent duplicate writes and verify background publishing outcomes.

Install and sign in

Install the CLI, create an instance profile, authenticate, and select a workspace.

On this page

Start here