Skip to main content
1

Install

npm install -g @opencx/cli
2

Authenticate

Two options: browser flow or API key.
opencx auth login
Opens a browser to authenticate and select a help center. For CI, set the OPENCX_API_KEY environment variable instead.
3

Initialize your project

Creates config files and content directory.
opencx content init
This creates opencx.toml, a docs/ content directory, and opencx-content-lock.json.
4

Write content

Create a topic folder with articles:
docs/
└── getting-started/
    ├── category.toml
    └── welcome.md
Example category.toml:
category.toml
name = "Getting Started"
description = "Learn the basics"
Example welcome.md:
welcome.md
---
title: Welcome to Our Help Center
meta_description: Get started with our product
---

Your article content here in markdown...
5

Preview locally

opencx content dev
Starts a local preview server.
6

Check and push

Validate, then push to OpenCX:
opencx content check
opencx content push
7

Pull existing content

If you already have content in your help center:
opencx content pull
Downloads published content to your local directory.

​
Next steps

Commands

Full command reference

Configuration

Config file reference

CI/CD

Automate deployments