Reference
Complete reference documentation for Kassie's features, commands, and APIs.
Quick Links
- CLI Commands - Complete command-line reference
- Configuration Schema - Full configuration options
- Keyboard Shortcuts - All keyboard shortcuts
- API Reference - gRPC and REST API documentation
- Error Codes - Error code meanings and solutions
What's in the Reference Section?
CLI Commands
Detailed documentation for all command-line interfaces, flags, and options. Learn every way to run Kassie.
Configuration Schema
Complete schema for the configuration file with all fields, types, defaults, and validation rules.
Keyboard Shortcuts
Full list of keyboard shortcuts for both TUI and Web UI, organized by context.
API Reference
gRPC service definitions and REST API endpoints for programmatic access and integration.
Error Codes
Comprehensive list of error codes with descriptions, causes, and solutions.
How to Use This Section
The Reference section is designed for quick lookups when you need specific information:
- New to Kassie? Start with the Guide section first
- Need a specific command? Jump to CLI Commands
- Forgot a shortcut? Check Keyboard Shortcuts
- Building an integration? See API Reference
- Got an error? Look up the code in Error Codes
Conventions
Throughout the reference documentation:
<required>- Required parameter[optional]- Optional parameter|- Alternative options...- Repeated elements
Example:
bash
kassie tui [--profile <name>] [--server <address>]This means both --profile and --server are optional parameters.