argstruct-spec
cli-guidelines
| argstruct-spec | cli-guidelines | |
|---|---|---|
| 1 | 48 | |
| - | 2,805 | |
| - | 1.5% | |
| - | 5.0 | |
| - | 21 days ago | |
| CSS | ||
| - | Creative Commons Attribution Share Alike 4.0 |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
argstruct-spec
-
CLI user experience case study
I ended up breaking that functionality away from the originally linked project. Its now in two parts (in case you go to look for it later)
Specification: https://gitlab.com/accidentallythecable-public/argstruct-spe...
Python module implementing specification: https://gitlab.com/accidentallythecable-public/python-module...
cli-guidelines
- Ask HN: Where to read about terminal UIs?
-
Ask HN: Do you read Secrets from Environment Variables
The Command Line Interface Guidelines [1] says:
> Do not read secrets from environment variables
> Secrets should only be accepted via credential files, pipes, `AF_UNIX` sockets, secret management services, or another IPC mechanism
Which one of these do you use? On github it seems common for projects to use environment variables for secrets.
[1] https://clig.dev/#environment-variables
-
Command Line Interface Guidelines
Seems they took a small step back from their previous "don't bother with man pages" stance. Now it's "Consider providing man pages."
I still find it a rather shocking order of priority, honestly.
https://clig.dev/#documentation
-
Ask HN: Best way to do scoped commands in a CLI app
- E. `blah project foo --edit`
Wondering if there was any guidance on this from the UNIX people. Perhaps scoping should be done using the file system. `cd path/to/project && blah edit`. Like git does with `git --cwd=path/to/project`. Maybe a virtual FS could even be used. Then you wouldn't have to continuously type in the scope with each command. Interesting thinking about how to maintain state in the terminal...thinking about how Python's virtual env bin/activate modifies the shell.
Found an interesting guide here: https://clig.dev/
-
CLI user experience case study
Capturing these guidelines is one of the primary reasons that https://clig.dev/ exists.
-
Introducing my Password Manager project - Seeking Feedback and Contributions
You may want to take a look at various existing CLIs to get inspiration on how they operate, the user feedback loop and the ergonomics on using them. Here is a great website on some CLI structing guidance https://clig.dev/
What are some alternatives?
redox - Mirror of https://gitlab.redox-os.org/redox-os/redox
nodejs-cli-apps-best-practices - The largest Node.js CLI Apps best practices list ✨
bubblewrap - Low-level unprivileged sandboxing tool used by Flatpak and similar projects
typer - Typer, build great CLIs. Easy to code. Based on Python type hints.
argparse-benchmarks-rs - Collected benchmarks for arg parsing crates written in Rust [Moved to: https://github.com/rosetta-rs/argparse-rosetta-rs]
picocli - Picocli is a modern framework for building powerful, user-friendly, GraalVM-enabled command line apps with ease. It supports colors, autocompletion, subcommands, and more. In 1 source file so apps can include as source & avoid adding a dependency. Written in Java, usable from Groovy, Kotlin, Scala, etc.
cligen - Nim library to infer/generate command-line-interfaces / option / argument parsing; Docs at
warg - Declarative and Intuitive Command Line Apps with Go
pico-args - An ultra simple CLI arguments parser.
nushell - A new type of shell
toml - Tom's Obvious, Minimal Language
tangetools