API Reference¶

The complete API documentation is generated using Dokka and provides detailed information about all classes, functions, and properties in the Argos library.

Quick Access¶

Core Classes

Arguments - Main DSL class

OptionBuilder - Option configuration

DomainBuilder - Subcommand support
Builders

NonNullableOptionBuilder - Required options

OptionListBuilder - List options

OptionSetBuilder - Set options
Terminal Support

Terminal - Output interface

ANSITerminal - Colored output

PlainTerminal - Plain text
Utilities

Completions - Shell completions

Help - Help generation

ValueSource - Value tracking

Browse Full API¶

→ Browse Complete API Documentation

Navigate to /dokka/ from the main site to access the complete Dokka-generated API documentation.

The complete API documentation includes:

All Classes: Complete class hierarchy with inheritance information
Method Documentation: Detailed parameter and return type information
Source Links: Direct links to source code on GitHub
Usage Examples: Code samples for complex features
Platform Information: Multiplatform availability details

Key Packages¶

`onl.ycode.argos`¶

Core package containing the main DSL classes and argument parsing functionality.

`onl.ycode.argos.terminal`¶

Terminal output and formatting support for different output types (ANSI, Plain, Markdown).

Search Tips¶

Use the search box in the API documentation to quickly find specific classes or methods
Click on class names to see detailed documentation and inheritance hierarchy
Use the navigation tree on the left to browse by package structure
Source links are available for each class to view the implementation on GitHub

The API documentation is automatically generated from the source code comments and stays in sync with the latest development.