cli-guidelines
clap-rs
cli-guidelines | clap-rs | |
---|---|---|
47 | 154 | |
2,788 | 13,327 | |
0.9% | 1.6% | |
3.6 | 9.5 | |
about 1 month ago | 3 days ago | |
CSS | Rust | |
Creative Commons Attribution Share Alike 4.0 | Apache License 2.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.
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/
clap-rs
-
Build Your Own curl - Rust
We will be using the library for Clap - A simple-to-use, efficient, and full-featured library for parsing command line arguments and subcommands.
-
CLI Contexts
I recently came across this question (and associated answer) on the clap repository. The answer given is a good one. But I wanted to expand with my own findings and practices, which spurred the motivation for this post.
-
Getting Started with CLI tools in Rust using Clap
We can also use tuple-like struct syntax and named-field struct syntax for enum variants within our enum; this is because unlike in other OOP languages, Rust enums are actually sum types. You can read more about how powerful Rust enums are in another article we wrote here. You can have optional arguments by simply wrapping the types in Option, but if you want to add a flag to a command you can use bool, since clap recognises that flags are either there or not there. Let's have a look at what this might look like:
-
Flow Updater JSON Creator
I began by developing a wrapper for the CurseForge API, which turned out to be a lengthy and challenging process but constituted the bulk of the work. Next, I coded the CLI, which was relatively straightforward. Instead of using the clap crate, a Rust tool for generating CLIs, I opted for the following line of code:
-
netcrab: a networking tool
By this time I had already gotten tired of parsing arguments by myself and had looked for something to help with that. I found a really dang good argument parsing library called clap. What makes it so cool is it's largely declarative for common uses. You simply mark up a struct with attributes, and the parser automatically generates the usage and all the argument parsing code.
-
Grimoire - A recipe management application.
How CLI arguments are handled (using clap).
- Rust 1.72.0
-
I made an alternative --help renderer for clap based applications
Is this just referring to wrapping based on the terminal width? That is supported with the wrap_help feature though I have been considering making it a default feature.
-
Looking for advice around project direction using artix-web
CLI, use Clap. If you want to get fancy, use Tui.
-
Build a HTTP server with Rust and tokio - Part 1: serving static files
As our CLI is getting more complex, we'll use the clap crate to parse the command line arguments.
What are some alternatives?
redox - Mirror of https://gitlab.redox-os.org/redox-os/redox
structopt - Parse command line arguments by defining a struct.
nodejs-cli-apps-best-practices - The largest Node.js CLI Apps best practices list ✨
argh - Rust derive-based argument parsing optimized for code size
bubblewrap - Low-level unprivileged sandboxing tool used by Flatpak and similar projects
docopt.rs - Docopt for Rust (command line argument parser).
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]
easy_flag - Simple command line flag parser for rust.
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.
serde - Serialization framework for Rust