Arkham Terminal UI Kit
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Joe Bellus 93195bab1b Merge branch 'v0.1.1' into 'main' 1 year ago
benches Config files can be loaded and used in conjunction with command line opts. Config file loading is behind features for JSON and TOML loading. Config files can be used to automatically provide defined CLI opts as well as arbitrary data, all of which can be retrieved from the get_value functions in the Context given to handler functions. 1 year ago
examples General imrovements 1 year ago
src General imrovements 1 year ago
.gitignore Core app foundation/opt parsing 1 year ago
.gitlab-ci.yml Config files can be loaded and used in conjunction with command line opts. Config file loading is behind features for JSON and TOML loading. Config files can be used to automatically provide defined CLI opts as well as arbitrary data, all of which can be retrieved from the get_value functions in the Context given to handler functions. 1 year ago
Cargo.lock General imrovements 1 year ago
Cargo.toml General imrovements 1 year ago
LICENSE Preparing for publishing crate on crates.io. 1 year ago
README.md General imrovements 1 year ago

README.md

Arkham is a framework for building CLI tools and applications. It provides basic building blocks for building attractive and smooth CLIs

CLI Features

Option Parsing

  • Opt/Flag handling for short, long command line options
  • Nested subcommands with their own flags
  • Opts are hierarchal and can be utilized from parent commands
  • Automatic usage details for subcommands and bare execution
  • Flags and options can be set via environment variables

Configuration Handling

Configurations can be loaded from either TOML or JSON files. Configuration files can be used to automatically provide values for command line opts or arbitrary configuration values

Styling

  • Canned helper methods for generating colored and formatted outputs for common structures: Detail lists, headers, etc.

Basic Usage

  • fib - An example using subcommands and command line options
  • config - An example loading a configuration file. This must be ran with cargo run --example config --features toml_config