Introduction
1 min read
The OpenCX CLI is a command-line tool for managing your help center content as code. Instead of editing articles through a web dashboard, you write and organize Markdown files in your repository and sync them with OpenCX.
Content as Code
Treat your help center like a codebase:
- Version control your articles with Git
- Review changes through pull requests
- Deploy updates from CI/CD pipelines
- Work offline using your preferred editor
Key Commands
| Command | Description |
|---|---|
opencx content init | Scaffold a content directory with the correct structure |
opencx content check | Validate content files locally before pushing |
opencx content pull | Download existing content from your help center |
opencx content push | Publish local content to your help center |
opencx content diff | Preview what would change on the next push |
opencx content gate | CI gate that fails if local content is out of sync |
How It Works
- Organize Markdown files in a content directory (default:
docs/) - Configure your project with an
opencx.jsonfile - Authenticate with
opencx auth login - Push content to your help center with
opencx content push