Installation

#Prerequisites

• Bun 1.0 or later

#Install

Run the CLI directly without installing globally:

bunx @opencx/cli

Or with npx:

npx @opencx/cli

#Verify

Check that the CLI is working:

opencx --help

#Initialize a Project

Create an opencx.json config file and scaffold the content directory:

opencx content init

This generates an opencx.json with the following fields:

{
  "help_center_id": "<your-help-center-id>",
  "content_dir": "docs",
  "api_url": "https://api.opencx.io",
  "dashboard_url": "https://app.opencx.io",
  "provider": "opencx"
}

Set content_dir to the directory where your Markdown articles live. The default is docs.