Skip to main content

​
Usage

ocx build [path] [options]

​
Description

Build a registry from source files. This command validates the registry.jsonc manifest, generates the index.json and component packument files, and copies raw component files into the output directory. Intended for registry authors who want to publish their own components.

​
Arguments

ArgumentRequiredDescription
pathNoRegistry source directory (default: current directory)

​
Flags

FlagShorthandDefaultDescription
--out <dir>./distOutput directory
--dry-runfalseValidate and show what would be built
--show-validationfalseRun full validation before build; show detailed validation output in human mode
--cwd <path>Current directoryWorking directory
--jsonfalseOutput as JSON
--quiet-qfalseSuppress output

​
Examples

​
Build Registry in Current Directory

ocx build

​
Build from a Specific Directory

ocx build ./my-registry

​
Specify Output Directory

ocx build --out ./public

​
Validate Without Building

ocx build --dry-run

​
Show Validation Breakdown Before Build

ocx build --show-validation
When --show-validation is set, OCX always runs validation checks before building.
  • In human mode, it prints per-check validation results.
  • With --json or --quiet, validation still runs, but presentation follows those flags.

​
Output

$ ocx build
Building registry...
Built 5 components to dist

$ ocx build --json
{
  "success": true,
  "data": {
    "components": 5,
    "output": "/path/to/dist"
  }
}

​
Source Structure

The build command expects a registry.jsonc file in the source directory: 
my-registry/
  registry.jsonc        # Registry manifest
  files/
    agents/
      my-agent.md       # Agent definition
    plugins/
      my-plugin.ts      # Plugin file
    skills/
      my-skill/
        SKILL.md        # Skill definition

​
Errors

ErrorCauseSolution
Build errorsInvalid registry.jsonc or missing filesCheck error messages for details

​
See Also