arkham
/
arkham
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Arkham Terminal UI Kit
14 Commits 1 Branch 0 Tags 318 KiB
Rust 99.2%
Nix 0.8%
Go to file
Joe Bellus 93195bab1b Merge branch 'v0.1.1' into 'main' 
Added App::long_desc(self) which sets the root level description

See merge request arkham/arkham!4
 		2021-11-14 02:47:55 +00:00
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. 2021-06-21 01:24:32 +00:00
examples General imrovements 2021-11-14 02:47:55 +00:00
src General imrovements 2021-11-14 02:47:55 +00:00
.gitignore Core app foundation/opt parsing 2021-06-19 03:20:29 -04:00
.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. 2021-06-21 01:24:32 +00:00
Cargo.lock General imrovements 2021-11-14 02:47:55 +00:00
Cargo.toml General imrovements 2021-11-14 02:47:55 +00:00
LICENSE Preparing for publishing crate on crates.io. 2021-06-21 01:43:00 +00:00
README.md General imrovements 2021-11-14 02:47:55 +00:00

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