Home / Rust / Command-line

quicli — quickly build cool CLI apps in Rust

QuiCLI Quickly build cool CLI apps in Rust. Getting started Read the Getting Started guide! Thanks This is only possible because of all the awesome li
Information
Category: Rust / Command-line
Watchers: 13
Star: 544
Fork: 31
Last update: Sep 24, 2023
Resource links
https://killercup.github.io/quicli/
https://github.com/killercup/quicli

QuiCLI

Quickly build cool CLI apps in Rust.

Build Status Documentation License crates.io

Getting started

Read the Getting Started guide!

Thanks

This is only possible because of all the awesome libraries included here:

  • Structopt and Clap for the nice CLI with awesome argument handling, great error messages, and nice composability!
  • Serde for handling all things serializing and deserializing
  • failure for ergonomic error handling.
  • …and more to come!

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

34 Open More issues
Closed

Requirements Discussion: what is quicli?

This is a discussion on what the use case and requirements of these two libraries are.

stdcli's goal is basically to make creating a CLI in rust more like creating one in python from a user experience and ergonomics point of view. This means:

  • batteries included
  • almost everything you need is already imported
    • python, because of it's duct typing and general unsafetly, does not require you to import "something" to use methods on its types. Rust, on the other hand requires you to import a boatload of traits.
    • related: #18
  • "flush out" macros that should be in the stdlib like hashmap!
  • (not yet in stdcli but planned) provide feature flags to control which libraries you want so you can develop with "full batteries" and then pare everything down as your application dependencies become more clear. For instance, maybe ansi_term, pretty_tables, termstyle and tabwriter are all in the "full batteries" package, but then you can do features = ["style_termstyle"] to only have termstyle

Also related: require that all versions in quicli are of the form >=VERSION so that the user can mostly control which version is used.

What is quicli?

Qui CLI seems to have similar but not completely overlapping goals. I would prefer we merge forces rather than create competing libraries.

I think it should be possible through liberal use of feature flags to accomplish any usecase a user might want. I.e. features = "full_batteries" would depend-on-the-world, but features = "light" would give very minimal dependencies, and everything in between.

looking for feedback 
opened Jan 22, 2018 by vitiral 15
Closed

fix #43: pub use crates, add set_log_verbosity and feature=full-throttle

This does several things to, some of which is to integrate better with the ergo ecosystem.

  • Adds feature=full-throttle as suggested in #43, which allows disabling some of the included crates
  • Moves set_log_verbosity into a function so that users can more cleanly migrate away from the main! macro (I already had need of this in artifact).
  • Publically uses crates to improve the import story. For instance, to use clap (which is exported by quicli), I had to do: use quicli::prelude::structopt::clap, which now I can do use quicli::structopt::clap.

I am currently using both ergo and quicli together to rewrite artifact's CLI. I'll keep opening bugs/PRs as I find them!

opened Feb 10, 2018 by vitiral 14
Closed

Publish fancy guides/docs

I want to add some more examples and show them in a nice way, but I'm not yet sure how best to do that.

One idea:

  • Add docs/ folder that is deploy via Github Pages (with Jekyll)
  • put "literate Rust" in there (Markdown with code blocks)
  • parse the Markdown files in there with waltz and test that code as subcrate(s) on CI
looking for feedback 
opened Jan 22, 2018 by killercup 10
Closed

add and export path_abs crate

I am the creator and maintainer of the new path_abs crate and I think it solves a lot of ergonomic problems in rust (problems I see you re-solving with the fs module!).

Questions:

  • should we export path_abs types?
  • should fs module be deprecated?

Thanks!

maybe - use case needed 
opened Jan 22, 2018 by vitiral 10
Closed

WIP: use structopt (master) 0.2

Replaces #48.

cc @TeXitoi

opened Feb 10, 2018 by killercup 9
Closed

Use globwalk instead of glob

implementation of #74 .

Now, we can use {a, b} pattern.

opened Oct 6, 2018 by h-michael 8
Open

bail!() no longer works with quicli 0.4

I think this is caused by https://github.com/rust-lang-nursery/failure/issues/258 and https://github.com/rust-lang-nursery/failure/issues/110, but I thought it worth mentioning, as I hit this upgrading from quicli 0.3 to 0.4.

I'm not sure there's anything that can be done in this crate though, so feel free to close if you want.

Reproduction:

Source

use quicli::prelude::*;

fn main() -> CliResult {
    bail!("This does not work!");
}

Reproduction

cargo new quicli_bail; cd quicli_bail
cargo install cargo-edit
cargo add quicli
echo -e 'use quicli::prelude::*;\n\nfn main() -> CliResult {\n    bail!("This does not work!");\n}' >src/main.rs
cargo build

Result:

   Compiling test_quicli v0.1.0 (/Users/gib/tmp/test_quicli)
error[E0308]: mismatched types
 --> src/main.rs:4:5
  |
4 |     bail!("This doesn't work!");
  |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ expected struct `exitfailure::ExitFailure`, found struct `failure::error::Error`
  |
  = note: expected type `exitfailure::ExitFailure`
             found type `failure::error::Error`
  = note: this error originates in a macro outside of the current crate (in Nightly builds, run with -Z external-macro-backtrace for more info)

error: aborting due to previous error

For more information about this error, try `rustc --explain E0308`.
error: Could not compile `test_quicli`.

To learn more, run the command again with --verbose.
opened Jan 16, 2019 by gibfahn 1
Open

Include `read_input`?

My crate read_input seems to line up well with the aims of quicli. It helps make CLI tools quicker and easier to make.

It would be awesome if it could be included with quicli. Any feedback on my crate would also be welcome.

opened Dec 14, 2018 by ethanboxx 0
Open

Issue with glob in thumbnail tutorial

After I finished the thumbnail tutorial, I tried to test it and got this error

Error: No files match pattern `rust_memes/*`

After seeing that, I progressively commented out more code to get a minimal reproduction, and I was able to find that this block of code doesn't match anything

use quicli::prelude::*;

fn main() -> CliResult {
    let files = glob("src/*")?;
    println!("{:?}", files);
    Ok(())
}

~/dev/rust/thumbify master
❯ cargo run --
   Compiling thumbify v0.1.0 (/home/chris.pickard/dev/rust/thumbify)
    Finished dev [unoptimized + debuginfo] target(s) in 1.11s
     Running `target/debug/thumbify`
Error: No files match pattern `src/*`

Even though I clearly have matching files in my src/ directory

~/dev/rust/thumbify master
❯ ls src
main.rs

I'm sorry, I feel like I'm quite a thorn in your side at the moment

bug 
opened Dec 7, 2018 by chrispickard 2
Open

Add backtrace to errors

opened Oct 27, 2018 by spease 2
Open

Ignore `-v` if `RUST_LOG` is set

Related to #90

opened Aug 14, 2018 by dpc 1
Open

Turn on logging in all subcrates?

As it is right now, the -vvv enables logging only for the main crate. For some use-cases, the ability to log everything would make more sense. Any way to achieve it?

Right now even RUST_LOG no longer works.

opened Aug 14, 2018 by dpc 2

Contents

    Hyurl DEPRECATED SOFTWARE, SEE SFN INSTEAD.
    codetrial vue-cli-plugin-element - Vue CLI 3 Plugin to build an enterprise application with element-ui in seconds
    FriendsOfREDAXO YCOM Impersonate. Login as selected YCOM user 🧙‍♂️in frontend.
    0xngmi A list of ideas for cool stuff to build
    yoshuawuyts rust(1) cli prototype
    dfreniche A Tuist Template to quickly create CLI apps in Swift
    akiran Foundation Apps components built with React
    jeromedalbert Real world React apps and their open source codebases for developers to learn from
    DouyinFE Semi-UI: A modern, comprehensive, flexible design system and UI library. Quickly build beautiful React apps.
    Andarius A CLI tool to build beautiful command-line interfaces with type validation.
    Swisyn Android Onboarder is a simple and lightweight library that helps you to create cool and beautiful introduction screens for your apps without writing dozens of lines of code.
    tanaikech This is a CLI tool to execute Google Apps Script (GAS) at own terminal on local PC. Also this CLI tool can be used for managing files in Google Drive for OAuth2 and Service Account.
    mergesort A simpler way to do cool UITableView animations! (╯°□°）╯︵ ┻━┻
    mike-engel Write ReasonML and Bucklescript in your existing babel projects
    Kasun-bandara1 🍎Hello I am Quincy, I help's 🚶you cool your groups🌷.
    mikigraf Image-Processing-CLI-in-Rust — CLI for processing images, generating histograms.
    m0dch3n vue-cli-plugin-cordova - Vue CLI 3 Plugin to add Cordova easily to your project
    yue Build cross-platform desktop apps with system webview and native GUI widgets.
    mislav GitHub CLI extension for fuzzy finding, quickly switching between and deleting branches.
    lirantal The largest Node.js CLI Apps best practices list ✨
    ahmadawais Log your GitHub Stars Contributions with the ease of a command line CLI
    Share this repo

    Related Repos


    Command-line
    18
    Yahoo Finance CLI written in rust
    lukstei yahoo-finance-rust-cli Displays your configurable stock portfolio using Yahoo Finance data. It uses the WebSocket of the website to get real time (but
     
    Command-line
    9
    Vari (Väri) is a Rust library for formatting strings with colors and cosmetic stuff to the...
    azur1s Vari Vari (Väri) is a Rust library for formatting strings with colors and cosmetic stuff to the terminal. Like Rich library for Python. Installing [de
     
    Command-line
    4
    An esoteric programming language where the program is a Git repository
    Omnikar UnDAG UnDAG is an esoteric programming language where the program is a Git repository — the repository does not track the program, but rather is itsel
     
    Command-line
    21
    A tool to decompile MSVC PDB files to C++ source code.
    camden-smallwood PDB Decompiler About Usage Contributing About A tool to decompile MSVC PDB files to C++ source code. This tool is a work in progress and will most lik
     
    Command-line
    5
    🌈🙈 HDR -> display
    h3r2tic 🌈 🙈 notorious6 Experiments in mapping HDR stimulus to display via shaders and stuff. Building and running Should work on Windows and Linux ( 🐧 not
     
    Command-line
    3
    🏝️ Set wallpaper from your terminal!
    ahmadrosid WLP Set wallpaper from your terminal. It works on Linux, Mac and Windows. Installation Manual git clone https://github.com/ahmadrosid/wlp.git cargo in
     
    Command-line
    3
    A terminal music player
    curlpipe Synchron A terminal music player Installation This requires gstreamer as well as it's plugins and development libraries. You will also need a dbus ses
     
    Command-line
    12
    A CLI for configuring a GoXLR on Linux
    GoXLR-on-Linux GoXLR configuration utility A tool to initialize and configure a GoXLR without requiring a Windows VM. Setting Permissions Copy 50-goxlr.rules to /etc
     
    Command-line
    13
    Featured Dioxus projects on how to build clean user interfaces in Rust
    DioxusLabs Example projects with Dioxus This repository holds the code for a variety of example projects built with Dioxus. Each project has information on how t
     
    Command-line
    12
    A CLI for configuring a GoXLR on Linux
    GoXLR-on-Linux GoXLR configuration utility A tool to initialize and configure a GoXLR without requiring a Windows VM. Setting Permissions Copy 50-goxlr.rules to /etc
     
    Command-line
    10
    a webring of people who make cool stuff
    kognise overengineeRING a webring of people who make cool stuff. technology, music, art, writing, anything goes! https://overengineering.kognise.dev/ joining
     
    Command-line
    1k
    You shouldn't ever lose your work if you're using Git
    tkellogg Dura Dura is a background process that watches your Git repositories and commits your uncommitted changes without impacting HEAD, the current branch,
     
    Command-line
    13
    🐦 Download Twitter videos using your terminal!
    Sazzo Nazuna 🐦 Download Twitter videos using your terminal! Installation Binary Download the desired file for your OS (Windows, Mac, Linux) from https://gi
     
    Command-line
    12
    A lightweight TUI display/login manager written in Rust 🐒
    coastalwhite Lemurs 🐒 A TUI Display/Login Manager written in Rust WIP: Whilst the project is working and installable, there are still a lot of bugs and limitation
     
    Command-line
    6
    Decryption utility for Yaesu ham radio firmware images
    landaire porkchop Decryption utility for Yaesu ham radio firmware images. Background Yaesu provides a firmware update utility for their ham radios that contain