https://github.com/jesseduffield/lazycli

Turn static CLI commands into TUIs with ease
https://github.com/jesseduffield/lazycli

Last synced: about 2 months ago
JSON representation

Turn static CLI commands into TUIs with ease

• Host: GitHub
• URL: https://github.com/jesseduffield/lazycli
• Owner: jesseduffield
• License: mit
• Created: 2021-01-05T06:06:30.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-07-15T17:53:31.000Z (about 1 year ago)
• Last Synced: 2024-07-07T17:33:31.220Z (3 months ago)
• Language: Rust
• Size: 914 KB
• Stars: 325
• Watchers: 7
• Forks: 15
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# lazycli

Turn static CLI commands into TUIs with ease

![Demo Animation](../assets/demo.gif?raw=true)

Demo:

[](https://www.youtube.com/watch?v=CRzcOpjuYSs&ab_channel=JesseDuffield)

## Usage

Pick a command that spits out either a list or table of content, like `ls`, `docker ps`, `git branch`, or `git status --short`. Then run `lazycli -- `

```

lazycli -- ls

```

If you find yourself often using lazycli with a specific command, you can easily alias it like so:

```

echo "alias lcd=\"lazycli -- docker ps\"" >> ~/.zshrc

source ~/.zshrc

lcd

```

Right now some default keybindings are defined for common commands like `ls`, `docker ps`, `git branch`, `git status --short`, etc. But you can customise it for any commands you like! Just open the config file from within the program with `$` and start playing around.

lazycli is best suited towards any command-line program that spits out a list of items or a table. In your commands, simply refer to the column number by $0 for the first column, $1 for the second column, etc, and lazycli will do the rest. There are plenty of starting examples in the config that you'll be able to draw from.

## Installation

### Via Cargo

```

cargo install --locked lazycli

```

### Via binary

Download the binary from the [Releases Page](https://github.com/jesseduffield/lazycli/releases)

### Building from source

1) clone the repo:

```

git clone https://github.com/jesseduffield/lazycli.git

```

2) install

```

cargo install --locked --path .

```

3) run

```

lazycli -- ls

```

## QandA

* Q: Isn't this what fzf does?

* A: Not quite: fzf requires you to know the command ahead of time whereas lazycli lets you run commands after presenting you the data, and the content is refreshed after you run the command rather than the program closing (admittedly I haven't used fzf but I'm pretty sure that's all correct).