cli-guidelines
warg
Our great sponsors
cli-guidelines | warg | |
---|---|---|
47 | 7 | |
2,782 | 13 | |
2.8% | - | |
3.6 | 7.3 | |
about 1 month ago | about 8 hours ago | |
CSS | Go | |
Creative Commons Attribution Share Alike 4.0 | MIT License |
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.
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/
warg
-
An Efficient Struct Configuration Pattern For Golang
Funcopts aren't always appropriate, but boy do they make things more readable sometimes. I use them pervasively in warg to allow declarative nested CLI commands
-
Which packages do you recommend for building cli tools?
I wrote my own! https://github.com/bbkane/warg/
-
Major standard library changes in Go 1.20
Very useful! I'll be playing with the error tree additions and studying the HTTP interface extension to see if I can replicate the pattern for https://github.com/bbkane/warg values. Id like to be able to have value-specific output for different types of --help , even ones not in warg
-
Have you used generics?
I'm using to allow for custom flag types in my CLI parsing library- a lot less duplicate code
-
Go: Functional Options Are Slow
One thing that I find nicer with functional options is building tree-like data structures.
My command line parsing library uses them to declaratively build CLI apps with arbitrarily nested subcommands.
Some examples at https://github.com/bbkane/warg/tree/master/examples
-
How are YOU using generics so far?
I'm writing a CLI parsing library, and generics have let me consolidate most of the flag value functionality for different types. So the flags for dbz --level 9000 --type superSaiyan share most of the same code even though one is an int and one is a string. So much fewer copy-paste-modify lines of code now!
-
Unix command line conventions over time
This is largely what the Azure CLI does. It simplifies even further by eliminating the no-value option. Instead, you pass "true" or "false" as the value ( --example true ). It's a little more verbose but very easy to parse/write/generate. I like this convention so much I stole it for my homemade Golang CLI parsing library https://github.com/bbkane/warg/ .
What are some alternatives?
redox - Mirror of https://gitlab.redox-os.org/redox-os/redox
graph - A library for creating generic graph data structures and modifying, analyzing, and visualizing them.
nodejs-cli-apps-best-practices - The largest Node.js CLI Apps best practices list ✨
workgroup - Structured concurrency manager for Go
bubblewrap - Low-level unprivileged sandboxing tool used by Flatpak and similar projects
golang-generics-dao-example - Example using Generics with DAO
typer - Typer, build great CLIs. Easy to code. Based on Python type hints.
scan - Scan provides the ability to to scan sql rows directly to any defined structure.
argparse-benchmarks-rs - Collected benchmarks for arg parsing crates written in Rust [Moved to: https://github.com/rosetta-rs/argparse-rosetta-rs]
RCIG_Coordination_Repo - A Coordination repo for all things Rust Cryptography oriented
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.
infra - Infra provides authentication and access management to servers and Kubernetes clusters.