trogon
cli-guidelines
trogon | cli-guidelines | |
---|---|---|
10 | 48 | |
2,354 | 2,798 | |
1.3% | 1.3% | |
6.6 | 5.0 | |
about 2 months ago | 13 days ago | |
Python | CSS | |
MIT License | 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.
trogon
-
CLI user experience case study
https://github.com/Textualize/trogon
> Ultimately we would like to formalize this schema and a protocol to extract or expose it from apps. This which would allow Trogon to build TUIs for any CLI app, regardless of how it was built. If you are familiar with Swagger, think Swagger for CLIs.
-
Turn (almost) any Python command line program into a full GUI application with one line
If you don't mind TUI, https://github.com/Textualize/trogon "Easily turn your Click CLI into a powerful terminal application"
-
Things I've learned about building CLI tools in Python
The folks at Textualize have taken it one step further with https://github.com/Textualize/trogon
It's a neat way to make powerful CLIs more accessible to less-technical users.
- FLaNK Stack Weekly 29 may 2023
- Show HN: Trogon – An automatic TUI for command line apps
- Trogon - Auto-generate a TUI for CLI apps
- Turn your Click CLI into a TUI with a two-line change
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?
typer - Typer, build great CLIs. Easy to code. Based on Python type hints.
redox - Mirror of https://gitlab.redox-os.org/redox-os/redox
scikit-llm - Seamlessly integrate LLMs into scikit-learn.
nodejs-cli-apps-best-practices - The largest Node.js CLI Apps best practices list ✨
DB-GPT - AI Native Data App Development framework with AWEL(Agentic Workflow Expression Language) and Agents
bubblewrap - Low-level unprivileged sandboxing tool used by Flatpak and similar projects
fastgron - High-performance JSON to GRON (greppable, flattened JSON) converter
jikkou - The Open source Resource as Code framework for Apache Kafka
argparse-benchmarks-rs - Collected benchmarks for arg parsing crates written in Rust [Moved to: https://github.com/rosetta-rs/argparse-rosetta-rs]
hsh - better shell
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.