Configuratiebestand
2 min leestijd
Elk OpenCX-project heeft een opencx.json bestand in de projectroot. Het wordt automatisch aangemaakt door opencx auth login of opencx content init.
Voeg een $schema sleutel toe die verwijst naar het JSON-schema van de CLI voor editor autocompletie en validatie:
json
{
"$schema": "./node_modules/@opencx/cli/schemas/opencx-config.schema.json",
...
}
Velden
| Veld | Type | Vereist | Standaard | Beschrijving |
|---|---|---|---|---|
help_center_id | string | Ja | -- | De ID van het helpcentrum waarmee dit project synchroniseert. |
content_dir | string | Nee | "docs" | Relatief pad naar de map die je inhoudsbestanden bevat. |
api_url | URL string | Nee | "https://api.open.cx" | Basis-URL van de OpenCX API. Overschrijf voor zelf-gehoste instanties. |
dashboard_url | URL string | Nee | -- | URL van het OpenCX-dashboard. Gebruikt voor het genereren van links. |
provider | string | Nee | -- | Inhoudsprovider-identificatie. |
categories | object | Nee | -- | Categorie metadata gestructureerd per pad (bijv. "getting-started", "billing"). Elke waarde: { "name": string, "description"?: string, "icon"?: string }. Wanneer ontbrekend voor een pad, wordt de categorienaam afgeleid van de mapnaam. |
Voorbeeld
json
{
"$schema": "./node_modules/@opencx/cli/schemas/opencx-config.schema.json",
"help_center_id": "hc_abc123",
"content_dir": "docs",
"api_url": "https://api.open.cx",
"dashboard_url": "https://app.open.cx",
"categories": {
"getting-started": { "name": "Aan de slag" },
"billing": {
"name": "Facturering & Betalingen",
"description": "Facturen en abonnementen",
"icon": "credit-card"
}
}
}
Hoe Het Wordt Aangemaakt
Het uitvoeren van opencx auth login of opencx content init schrijft dit bestand naar je huidige werkmap. De help_center_id wordt interactief gekozen tijdens de setup en de overige velden worden ingevuld met verstandige standaardwaarden.
Validatie
De CLI valideert opencx.json bij elke opdracht die het leest. Als vereiste velden ontbreken of waarden onjuist zijn, zie je een duidelijke foutmelding die naar het ongeldige veld wijst. De velden api_url en dashboard_url moeten geldige URL's zijn.