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 - Scripting — running cxagent from a script or CI, and reading what it did
- A session, in pictures — captures from real sessions, mistakes included
New here? Install first — you do not need to write any configuration to start.
Writing a plugin
- Start here
— what a plugin is, and the path from
cxagent plugin newto the catalog - The SDK and its tutorials — a weather plugin in C#, a word counter in C, end to end
- The contract — the lifecycle, the sidecar, gating, commands, settings
- The command line
—
new,check,call,pack,verify - Testing — from the command line, and from a C# test with CxAgent.Plugins.Testing
- The C SDK
— the
cxpAPI and building for every platform - The C ABI
— what crosses each call, for a plugin written without
cxp - Publishing — pack, upload, verify, submit, with a worked entry for each shape
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