Expand description
Library facade for the oy command-line application.
oy is primarily a binary crate: install and run the oy CLI to inspect,
edit, audit, and ask questions about local repositories. The library surface is kept
intentionally small for the binary, integration tests, and lightweight embedders that
want to invoke the same command handlers.
Most implementation modules are private so their internals can evolve without creating
an API compatibility promise. If you need to automate oy, prefer spawning the oy
binary and using its documented CLI unless one of the functions below exactly fits your
use case.
Useful project documentation:
- README for installation and user guide.
- Architecture for runtime flow, module responsibilities, and trust boundaries.
- Tool safety for capability and approval-mode details.
Enums§
- Output
Mode - Controls how much user-facing output
oywrites while it runs.
Functions§
- chat_
help_ text - Returns the interactive chat help text shown by
/help. - err_
line - Writes a formatted diagnostic line to standard error using the current UI output mode.
- preview_
tool_ output - Formats a tool result using the same compact preview renderer as the CLI.
- run
- Runs the
oycommand dispatcher with command-line arguments excluding the program name. - set_
output_ mode - Sets the process-wide output mode used by CLI rendering helpers.