Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developer.kodexa.ai/llms.txt

Use this file to discover all available pages before exploring further.

Kodexa configuration works best when it is treated as code: reviewed in Git, validated before deployment, and promoted through environments with the same discipline as application changes. Claude Code can help with that workflow through the Kodexa Metadata Skills plugin. The plugin gives Claude Code resource-specific guidance for authoring Kodexa metadata on disk, including Activity Plans, task templates, data definitions, data forms, knowledge resources, project templates, modules, service bridges, prompt templates, and KDX CLI sync workflows.
Use this workflow when your Kodexa configuration lives in a Git repository or you want it to. For one-off operations, use the KDX CLI resource operations directly.

​
The Workflow

The normal loop is: Claude Code helps you work inside the repository. The KDX CLI is still the tool that talks to Kodexa.

​
What Claude Code Should Help With

Use the skills for resource authoring, cleanup, and review:
WorkSkill to useOutput
Model a business processactivity-planActivity Plan YAML with steps, inputs, dependencies, and actions
Define human review worktask-template and data-formTask template YAML and V2 data form JSON
Model extracted business datadata-definitionData definition YAML
Adapt behavior by document contextknowledge-systemFeature types, item types, knowledge sets, and project knowledge items
Connect to external systemsservice-bridgeService bridge YAML for API proxy endpoints
Package custom logicmoduleModule metadata and implementation layout
Deploy and validatekdx-cliSync, validate, dry-run, push, and deploy commands
For new workflow orchestration, start with Activity Plans. A Task is the human work item inside the process; the Activity Plan is the reusable process definition.

​
What Stays In Git

A typical metadata repository includes: 
my-kodexa-config/
├── sync-config.yaml
├── manifests/
│   └── finance.yaml
├── kodexa-resources/
│   ├── activity-plans/
│   ├── data-definitions/
│   ├── data-forms/
│   ├── knowledge-sets/
│   ├── modules/
│   ├── project-templates/
│   ├── projects/
│   ├── service-bridges/
│   ├── task-statuses/
│   └── task-templates/
└── .sync-state/
Commit the metadata files, manifests, sync-config.yaml, and .sync-state/. Do not commit API keys, secrets, generated logs, or local scratch files.

​
Human Review Still Matters

Claude Code should draft and modify configuration, but a developer or platform owner should still review:
  • Business meaning: Does the Activity Plan match the real process?
  • References: Do task templates, forms, data definitions, modules, bridges, and knowledge sets exist in the target organization?
  • Scope: Are changes limited to the intended project or reusable resource?
  • Safety: Are secrets referenced by name instead of written into YAML?
  • Deployment behavior: Does kdx sync push --dry-run or kdx sync deploy --dry-run show only the expected changes?

​
Pages In This Section

Install the Kodexa Skills

Install the Claude Code plugin and learn how skills are invoked.

Author Metadata

Use Claude Code to safely create and edit Kodexa configuration in a Git repository.

Sync with KDX

Pull, validate, dry-run, push, and deploy metadata with the KDX CLI.

KDX Sync Reference

Go deeper on sync configuration, manifests, conflict detection, and CI/CD.