Browse documentation

Overview

Overview

Start here

Your first CLIRunnable examplesGuide index

How do I...?

Common recipesShell completionProject generator

Learn

Commands and subcommandsOptions and validationOutput, errors, and progress

Reference

Public APICurrent limitations

Inside cli-fp

Technical design

Project

Contributing and support

Contributing and support

cli-fp is a small open-source framework maintained around a deliberately small public API. v1.4.2 is a correctness and maintenance patch: the supported runtime remains the class-based API described in these guides.

Supported environments

Contribute a change

Read the contribution guide, then run the platform-appropriate framework, generator and cleanup checks before opening a pull request. Documentation changes should keep examples runnable and should not expose internal units as beginner APIs.

Useful project records:

When documentation and source disagree, treat the current public units under src/ and behaviour covered by tests as authoritative.