Skip to main content
opencx
Home
Search...
⌘K
Topics
Getting Started
Content Format
Content Management
Configuration
Ci Cd
Examples
Toggle Sidebar
Search...
Search articles, settings...
How can we help?
Search our knowledge base for answers
Results for "Getting Started"
Installation
Run the CLI directly without installing globally:
1 min read
Updated Mar 16, 2026
Mermaid Diagrams
Mermaid lets you define diagrams as code inside fenced code blocks. The help center renders them as interactive SVGs.
2 min read
Updated Mar 7, 2026
Introduction
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…
1 min read
Updated Mar 16, 2026
Authentication
Run the login command to authenticate through your browser:
1 min read
Updated Mar 7, 2026
Project Structure
The CLI manages help center content as a directory of Markdown files, organized by category.
1 min read
Updated Mar 16, 2026
Configuration File
Every OpenCX project has an opencx.json file in the project root. It is created automatically by opencx auth login or opencx content init.
1 min read
Updated Mar 16, 2026
Category Metadata
Category metadata (name, description, icon) lives in opencx.json under the optional categories key. Each key is the category path relative to content_dir (e.g.…
1 min read
Updated Mar 16, 2026
Article Files
Articles are Markdown files with YAML frontmatter. The file's slug is derived from its filename minus the .md extension.
1 min read
Updated Sep 28, 2026