Are you an LLM? View /llms.txt for optimized Markdown documentation, or /llms-full.txt for full documentation bundle. This page is also available as Markdown at /reference.md
logo
  • Getting Started
  • Concepts
  • Guides
  • Reference
    ›Reference
    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

    #Reference

    bootstrap
    Bootstrap and run a CLI application. Registers commands, parses arguments, loads config, runs middleware, and invokes the matched handler.
    reference/cli
    The developer CLI for scaffolding, building, and diagnostics.
    clitooling
    command
    Define a command with typed options, positionals, and a handler function.
    reference/maltty
    The runtime framework for commands, middleware, auth, and terminal UI.
    frameworkruntime
    middleware
    Define middleware that wraps command execution with pre/post logic.
    report
    Structured reporting middleware. Decorates `ctx.report` with methods for writing checks, findings, and summaries.
    screen
    Define a command that renders a React/Ink terminal UI instead of running a handler.
    Previous pageTesting Your CLINext pagebootstrap
    ON THIS PAGE

    Docs

    • Getting Started
    • Guides
    • Reference

    Project

    • GitHub
    • npm
    • Contributing

    ByteFarm

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