*REF:*
*README.md:*
NAME
···
----
`clee`
TL;DR;
--------
`clee` is a tiny, 0 dependency, DSL for building über clean CLIs in Ruby
INSTALL
-------
648327251a3d80516bc11fc8ebc9f989
URI
---
GitHub - ahoward/clee: `clee` is a tiny, 0 dependency, DSL for building über clean CLIs in Ruby
ABOUT
-----
`clee` is a minimalist version of `main` (GitHub - ahoward/main: a class factory and dsl for generating command line programs real quick),
a
command line DSL i wrote almost 15 years ago, that has seen over [4 million
downloads](lotta rubygems...🦒)
then why should i use `clee` instead of `main` ?
* `clee` has 0 dependencies beyond ruby itself
* `clee` is very very small
drawohara@drawohara.dev:ahoward #=> loc clee/lib
clee/lib/clee.rb: 478
===
@loc: 478
drawohara@drawohara.dev:ahoward #=> loc main/lib
main/lib/main/cast.rb: 139
main/lib/main/daemon.rb: 395
main/lib/main/dsl.rb: 65
main/lib/main/factories.rb: 24
main/lib/main/getoptlong.rb: 245
main/lib/main/logger.rb: 43
main/lib/main/mode.rb: 41
main/lib/main/parameter.rb: 589
main/lib/main/program/class_methods.rb: 362
main/lib/main/program/instance_methods.rb: 274
main/lib/main/program.rb: 6
main/lib/main/softspoken.rb: 12
main/lib/main/stdext.rb: 34
main/lib/main/test.rb: 69
main/lib/main/usage.rb: 159
main/lib/main/util.rb: 96
main/lib/main.rb: 70
===
@loc: 2623
* you can use this to decide which to use:
a64d2969d05860c0ebe5cf2fe45a68f4
API
---
##### `clee`'s api is very simple. it has every feature you need, and none
that you
don't, including:
- auto generated help messages
- support for `my_clee --help` and `my_clee help` to 'just work'
- support for modifying help/usage messages simply
- sane exit codes
- support for --options, env=val pairs, etc
- argv parsing
- fancy color'd logging
- modes, and sub-modes
##### the smallest clee script looks like this
f220e2252b83290c5cfda29af1ea63dc
##### you can name your scripts
dfc651c50afa14333d2ebcc4e83c8473
##### you can alter the default tldr, and help messages
79e03bc6b850cdc3ef2c214c04fbd5ee
5203d62483ee026245b222da18d44e8d
##### specifying params is trivial
6d2d3aa5e20f0c76e8ff227c308ccc00
##### modes, and sub-modes, are supported
2f99663e1f94f3a719c26a37a3e7bdb1
##### assuming you saved the above as `my_clee`, you could then do
a24b8645b0719afcb6439179285a4480
##### `clee` scripts have a sweet dependency-less colored logger that
understands what a #tty really is...
99d210de11b2f4dfd29b57188fbeebf9
##### `clee` ships with a lil code-gen-thang
02ec70f58664294d7c7f8709948eacb8
i could write more docs but, they would then outnumber the LOC of the
library
so:
1. see [./lib/clee.rb](./lib/clee.rb)
2. if that still doesn't float your boat install `ima`, a universal
command-line filter built on `clee`, that brings AI to your CLI and do
something like this
4c01f35dac0a288421210168e99a347b
which might produce something like this ->
---
Clee is a Ruby library that provides a simple way to create command-line
interfaces (CLI) for Ruby applications. It allows developers to define
commands, options, and parameters for their application, and handles the
parsing and execution of these commands.
The core features of Clee include:
* Command definition: Clee allows developers to define commands and their
associated options and parameters.
* Option parsing: Clee can parse command-line options and parameters, and
provides a simple way to define and handle these options.
* Parameter handling: Clee provides a way to handle command-line
parameters, including required and optional parameters.
* Help generation: Clee can generate help text for commands and options,
making it easy to provide documentation for users.
* Logging: Clee provides a logging mechanism that allows developers to log
messages at different levels (e.g. debug, info, warning, error).
Clee is designed to be flexible and customizable, making it easy to
integrate into existing Ruby applications. It also provides a number of
features that make it easy to use, including automatic help generation and
logging.
Some of the key concepts in Clee include:
* Commands: These are the top-level actions that a user can perform with
the application.
* Options: These are the flags or switches that can be used to modify the
behavior of a command.
* Parameters: These are the values that are passed to a command or option.
* Modes: These are alternative behaviors that a command can exhibit,
depending on the options or parameters passed to it.
Overall, Clee is a powerful and flexible library that makes it easy to
create command-line interfaces for Ruby applications. Its simple and
intuitive API makes it easy to use, even for developers who are new to CLI
development.
---
SING IT 🎵
----------
* **DOCS are dead, long live AI!**
* **UIs are dead, long live CLIS!**
FINALLY
-------
why `clee`? that is honestly such a stupid name...
a good friend used to pronounce 'cli' as 'clee'. it stuck. i like it.
i still need you write more docs for this free code
[c'mon in!](Pull requests · ahoward/clee · GitHub)
--
- a
"be kind whenever possible. it is always possible." -- h.h. the 14th
dalai lama
-->> https://drawohara.io