Skip to main content

Crate oy

Crate oy 

Source
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§

OutputMode
Controls how much user-facing output oy writes 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 oy command dispatcher with command-line arguments excluding the program name.
set_output_mode
Sets the process-wide output mode used by CLI rendering helpers.