Documentation
Three audiences, and what each one needs.
The pages below are rendered from the repository's own markdown rather than copied — the source is edited in one place, and a link at the foot of each takes you to it. Anything not rendered here links to GitHub, because it is written for someone already reading the source.
Using cxagent
- Commands
— everything you can type in the composer:
/mode,/stats,/plugin,/skills, and the keys - Configuration
— every block of
config.json, where the file lives on each OS, and what each key's absence means
New here? Install first — you do not need to write any configuration to start.
Writing a plugin
- The on-ramp — from the calculator example to a catalog submission
- The contract — the lifecycle, the sidecar, gating, settings, and the managed and ABI interfaces
- Releasing a plugin
— adding a catalog entry, with a worked example of each
sourceshape
Embedding CxAgent.Core
- Overview — what the library is, and the four calls an app makes
- API reference — every public type, configuration, and tool selection
- Tools
— injecting tools of your own:
IAgentTool, the two gates, and whatGateshould return - Examples — five runnable apps, from a console front end to a plugin in C
Elsewhere in the repository
- README — what cxagent is, and what it actually does to your machine
- A session, in pictures — eighteen captures from real sessions, mistakes included
- Roadmap — what is next