> crest
  • Getting Started
  • Commands
  • Tables
  • Advanced
  • GitHub

Getting Started

  • Installation
  • Maven Project Setup
  • Your First Command
  • Entry Point
  • Testing Commands

Commands

  • Annotations
  • Options Classes
  • Command Groups
  • Return Types
  • I/O Streams
  • Help

Table Formatting

  • The @Table Annotation
  • Border Styles
  • Table Options
  • Programmatic Table Building
  • Cell Formatting

Advanced

  • Type Conversion
  • Interceptors
  • Validation
  • Editors
  • Loader
  • Exit Codes

Getting Started

Set up Crest and write your first CLI command in minutes.

Get up and running with Crest quickly. This section covers installation, your first command, and how Crest discovers and runs commands.

Installation

Add Crest to your project with Maven coordinates or generate a new project with the archetype.

Maven Project Setup

Add a CLI module to an existing Maven project using the shade plugin and crest-maven-plugin.

Your First Command

Write a simple CLI command using @Command, @Option, and @Default.

Entry Point

Configure how Crest discovers commands and launches your CLI application.

Testing Commands

Test Crest commands in-process using Main.builder() and PrintString.

© Tomitribe. Apache License 2.0. GitHub · Community