mono/packages/kbot/docs_/commands.md
2025-04-07 18:52:59 +02:00

1.4 KiB

Main Commands

The primary way to interact with kbot for processing tasks is by invoking it with a prompt and various options. While often used implicitly, this typically corresponds to the run command.

Running Tasks

kbot run [options...] "Your prompt here..."
# or simply (if 'run' is the default):
kbot [options...] "Your prompt here..."

This command executes the main AI processing pipeline based on the provided prompt and options. Key aspects controlled by options include:

  • Input: Specified via --include (files, directories, web URLs), --path.
  • Task: Defined by the --prompt.
  • Behavior: Controlled by --mode (e.g., tools, completion).
  • Output: Directed using --dst or --output.
  • Model & API: Configured with --model, --router, --api_key, etc.

Refer to Parameters and Modes for detailed options.

Utility Commands

Other potential utility commands might include:

  • kbot fetch: Fetch updated information, such as the latest available models.
  • kbot init: Initialize a directory or project for use with kbot (e.g., create default config files).
  • kbot help-md: Generate extended help documentation in Markdown format.
  • kbot examples: Show example usage patterns.

(Note: Availability and exact behavior of utility commands may vary.)