Skip to main content
The OpenCX CLI lets you manage help center content the way you manage code — write articles in Markdown, version them in Git, and push to your help center from the terminal or CI.

​
Who uses the CLI

  • Technical writers who prefer Markdown and pull requests over a web editor.
  • Engineering teams syncing product docs into a customer-facing help center from the same repo.
  • CI pipelines that publish content on merge.

​
What it does

Write articles as .md files in a local docs/ directory with category.toml per topic. The CLI converts them to your help center articles on push.
opencx content push publishes local changes. opencx content pull fetches remote edits into your working tree, so dashboard-authored and CLI-authored content stay in sync.
opencx content check validates every article against your help center’s rules — broken internal links, missing translations, malformed frontmatter — before you push.
Set OPENCX_API_KEY in your CI environment and call the CLI from a workflow step. See CI/CD Integration.
Start with the Quickstart to install, authenticate, and push your first article in under five minutes.

Quickstart

Install, authenticate, and push your first article.

CLI Commands

Reference for every opencx subcommand.

Configuration

opencx.toml options and environment variables.

CI/CD Integration

Publish help center content from GitHub Actions or other pipelines.