coal 0.0.2

A suite for easily building beautiful command-line apps.

Coal

A suite for easily building beautiful command-line apps.

Warning

The Coal is still in development and may not be fully functional.

Coal is not a CLI framework! It's intended to provide a convenient and easy-to-use command-line tool for existing CLI frameworks and developers.

Coal also doesn't plan to add command functionality. Its purpose is to enhance existing CLI packages.

Modules

Entry	Description
package:coal/args.dart	Provides command-line argument parsing functionality.
package:coal/utils.dart	Provides utility functions for ANSI escape codes.

Roadmap

• ✅ Args: Command-line argument parsing
• ✅ Utils: ANSI utility functions
• ❌ Keypass: Binding key input
• ❌ Readline: Waiting for input
• ❌ Prompt: Basic prompt process support and CLI frame handling.
• ❌ Prompt Utils: Advanced commonly used prompt utils
• ❌ Tab: Shell command autocompletion
• ❌ Tab Adapters: Adds tab completion adapters for popular Dart CLI packages.

Installation

To install the Coal suite, run the following command:

dart pub add coal

Args Parser

Coal provides a powerful argument parser that allows you to define and parse command-line arguments easily:

import 'package:coal/args.dart';

final input = const input = ['--a=1','-b','--bool','--no-boop','--multi=foo','--multi=baz','-xyz'];
final args = Args.parse(input);

print(args.toJson());

{
  "a": 1,
  "b": true,
  "bool": true,
  "boop": false,
  "multi": ["foo", "baz"],
  "x": true,
  "y": true,
  "z": true
}

Warning

Coal is currently under development and documentation is not yet ready.

ANSI Utility

Coal has prepared a series of convenient tools for generating ANSI:

• Clear: Generate clear ANSI text utility.
• Cursor: Generate cursor operation ANSI text utility.
• Erase: Erase ANSI text utility.
• Scroll: Scroll ANSI text utility.
• Text: Generate text ANSI text utility.

Clear

Name	Description
clearScreen()	Clear the terminal screen.

Cursor

Name	Description
cursorUp()	Move the cursor up by count lines.
cursorDown()	Move the cursor down by count lines.
cursorForward()	Move the cursor forward by count columns.
cursorBackward()	Move the cursor backward by count columns.
cursorNextLine()	Move the cursor to the next line by count lines.
cursorPrevLine()	Move the cursor to the previous line by count lines.
cursorTo()	Move the cursor to the specified position.
cursorMove()	Move the cursor by x columns and y lines.
cursorShow	Show the cursor.
cursorHide	Hide the cursor.
cursorSave	Save the cursor position.
cursorRestore	Restore the cursor position.
cursorLeft	Move the cursor left by one column.

Erase

Name	Description
eraseScreen	Erase the entire screen.
eraseLine	Erase the current line.
eraseLineStart	Erase from the current cursor position to the beginning of the line.
eraseLineEnd	Erase from the current cursor position to the end of the line.
eraseUp()	Erase count lines above the current cursor position.
eraseDown()	Erase count lines below the current cursor position.
eraseLines()	Erase count lines above and below the current cursor position.

Scroll

Name	Description
scrollUp()	Scroll the screen up by count lines.
scrollDown()	Scroll the screen down by count lines.
scrollLeft()	Scroll the screen left by count columns.
scrollRight()	Scroll the screen right by count columns.

Text

• stripVTControlCharacters(): Remove all VT control characters. Use to estimate displayed string width.
• getTextTruncatedWidth(): Get the width of a string when truncated to fit within a given width.
• getTextWidth(): Get the width of a string.
• wrapAnsi(): Wrap a string to fit within a given width.
• styleText: Generate a string with ANSI escape codes for styling.

Style Text

// Dart SDK >= 3.10.0
final text = styleText('Hello, World!', [.red]);
// <= 3.10.0
final text = styleText('Hello, World!', [TextStyle.red]);

License

MIT License