logo
  • Getting Started
  • Concepts
  • Guides
  • Reference
    ›Concepts
    Getting Started
    Introduction
    Quick Start
    Concepts
    Authentication
    Configuration
    Context
    Icons
    Lifecycle
    Reporting
    Screens
    Guides
    Add Authentication
    Build a CLI
    Build a Compiled CLI
    Component Stories
    Testing Your CLI
    Reference
    bootstrap
    cli
    command
    maltty
    middleware
    report
    screen
    Contributing

    New: maltty

    The batteries-included TypeScript CLI framework. Ship your first command in five minutes.

    Quick Start

    #Concepts

    Authentication
    The auth system for maltty CLIs. Provides credential resolution from multiple sources, an interactive login flow, persistent token storage, and automatic HTTP header injection.
    Configuration
    The configuration system for maltty CLIs. Supports multiple file formats, automatic discovery, Zod schema validation, and a typed config client API.
    Context
    The central API surface threaded through every handler and middleware. Provides typed access to args, config, log, format, store, error handling, and CLI metadata.
    Icons
    The icons system provides Nerd Font glyph resolution with automatic emoji fallback, font detection, interactive installation prompts, and categorized icon definitions for maltty CLIs.
    Lifecycle
    How a CLI invocation flows through maltty, from `process.argv` to process exit.
    Reporting
    Structured terminal output for diagnostic commands. The report middleware decorates `ctx.report` with methods for writing checks, findings, and summaries.
    Screens
    maltty supports two command authoring models: handler-based commands for sequential log-and-exit flows, and screen-based commands for interactive React/Ink terminal UIs. Screen commands replace the handler function with a React component that receives parsed args as props.
    Previous pageQuick StartNext pageAuthentication
    ON THIS PAGE

    Docs

    • Getting Started
    • Guides
    • Reference

    Project

    • GitHub
    • npm
    • Contributing

    ByteFarm

    • bytefarm.sh
    • Discord
    © 2026 ByteFarm
    The batteries-included TypeScript CLI framework.