Skip to content

Latest commit

 

History

History
30 lines (21 loc) · 2.19 KB

README.md

File metadata and controls

30 lines (21 loc) · 2.19 KB

rtk-engine

The RTK pipeline engine: it parses, resolves and validates pipeline.toml, evaluates rules, and runs the methods and chains those rules name. The rtk CLI links it for the hooks; the rtk-proxy daemon links it for proxy.request rules.

User documentation

The pipeline reference lives in the user guide, docs/guide/pipelines/, published at rtk-ai.app/guide:

Page Covers
Pipelines what the engine does, the files you might write, upgrading
Writing a Pipeline file locations and load order, the rule tree, actions, routing, overrides
Conditions and Judges every when key, the call context, classifiers
Methods built-in methods and chains, your own chains and filters
Directives text RTK puts in front of the agent
Tasks and Upstreams delegation to a cheaper model
Reference Pipelines the six built-ins as literal files
Pipeline Commands show, validate, explain, shadow, share, adopt
Errors and Warnings every diagnostic code, limits
Plugins new methods and task kinds in Rust

Worked pipelines: examples/pipelines/.

Contributing

See CONTRIBUTING.md. rtk methods list prints every registered method with its contract.

License

Business Source License 1.1 — source-available, not OSI open source. Production use is free; offering the engine, or a derivative, to third parties as a paid or hosted product needs a licence from contact@rtk-ai.app. On 2030-09-09 this version converts to Apache-2.0. The rtk CLI's own source is Apache-2.0, and its Apache-2.0 edition is built without this crate — see Editions and Licensing.