#tui #editor #git #version-control #linux-macos #tuify

bin+lib r3bl-cmdr

A TUI app suite for developers. Includes a Markdown editor edi and a git client giti.

13 releases

0.0.13 May 20, 2024
0.0.12 May 12, 2024
0.0.11 Jan 15, 2024
0.0.8 Dec 23, 2023
0.0.2 Jun 15, 2022

#114 in Command line utilities

Download history 15/week @ 2024-02-23 7/week @ 2024-03-01 16/week @ 2024-03-29 1/week @ 2024-04-05 4/week @ 2024-04-26 61/week @ 2024-05-03 171/week @ 2024-05-10 173/week @ 2024-05-17 26/week @ 2024-05-24

431 downloads per month

Apache-2.0

6.5MB
28K SLoC

Suite of R3BL TUI apps focused on developer productivity

R3BL CMDR is comprised of two apps

  1. giti 🐱 is an interactive CLI app to give you more confidence when working with git 💪.
  2. edi 🦜 is a TUI Markdown editor that lets you edit Markdown files in your terminal in style 💖.
  • These apps are currently available as 🐣 Early Access Preview.
  • They run on Linux, macOS and Windows, and are written in Rust 🦀.

Install the apps on your system using cargo

To install r3bl-cmdr on your system, run the following in your terminal:

cargo install r3bl-cmdr
  • 📦 You will need cargo installed on your system. If you don't have it, follow the instructions here to install it.
  • 🐧 On Linux you will need libssl-dev installed on your system. On Ubuntu based systems, you can get it by running sudo apt install libssl-dev pkg-config. For other distros, please refer to this stackoverflow question.

R3BL giti - perform version control with confidence

R3BL giti 🐱 is an interactive CLI app to give you more confidence when working with git 💪.

Commands that allow you to work with branches

Command Description
giti --help See all the available commands
giti branch List all the branch subcommands
giti branch delete Delete one or more local branches
giti branch checkout Checkout a branch
giti branch new Create a new branch

See giti branch delete in action

R3BL giti 🐱: how to interactively delete multiple branches with giti: https://www.youtube.com/watch?v=aI550ZvuD0s

See giti branch checkout in action

R3BL giti 🐱: how to interactively switch to a new branch using giti: https://youtu.be/pc4BP1GjFGo?si=J_2021-5g0XTuSPe

See giti branch new in action

R3BL giti 🐱: how to interactively create a new branch with giti: https://youtu.be/u_OqQyRQEZM?si=V4xt6xdAYNMz-2lb

Run giti binary target

To run from binary:

  • Run cargo install r3bl-cmdr (detailed instructions above). This will install giti locally to ~/.cargo/bin.
  • Run giti from anywhere on your system.
  • Try giti --help to see the available commands.
  • To delete one or more branches in your repo run giti branch delete.
  • To checkout a branch run giti branch checkout.
  • To create a new branch run giti branch new.

To run from source:

  • Clone the r3bl-open-core repo.
  • Go to the cmdr folder in your terminal.
  • Run nu run install to install giti locally to ~/.cargo/bin.
  • Run giti from anywhere on your system.
  • Try giti --help to see the available commands.
  • To delete one or more branches in your repo run giti branch delete.
  • To checkout a branch run giti branch checkout.
  • To create a new branch run giti branch new.
  • If you want to generate log output for giti, run giti -l. For example, giti -l branch delete. To view this log output run nu run log.

R3BL edi - edit Markdown files in your terminal in style

🦜 edi is a TUI Markdown editor that lets you edit Markdown files in your terminal in style 💖.

Run edi binary target

https://github.com/nazmulidris/developerlife.com/assets/2966499/f2c4b07d-b5a2-4f41-af7a-06d1b6660c41

To run from binary:

  • Run cargo install r3bl-cmdr (detailed instructions above). This will install giti locally to ~/.cargo/bin.
  • Run edi from anywhere on your system.
  • Try edi --help to see the available commands.
  • To open an existing file, run edi <file_name>. For example, edi README.md.

To run from source:

  • Clone the r3bl-open-core repo.
  • Go to the cmdr folder in your terminal.
  • Run nu run install to install edi locally to ~/.cargo/bin.
  • Run edi from anywhere on your system.
  • Try edi --help to see the available commands.
  • To open an existing file, run edi <file_name>. For example, edi README.md.
  • If you want to generate log output for edi, run edi -l. For example, edi -l README.md. To view this log output run nu run log.

Build, run, test tasks

Prerequisites

🌠 In order for these to work you have to install the Rust toolchain, nu, cargo-watch, bat, and flamegraph on your system. Here are the instructions:

  1. Install the Rust toolchain using rustup by following the instructions here.
  2. Install cargo-watch using cargo install cargo-watch.
  3. Install flamegraph using cargo install flamegraph.
  4. Install bat using cargo install bat.
  5. Install nu shell on your system using cargo install nu. It is available for Linux, macOS, and Windows.

Nushell scripts to build, run, test etc.

Command Description
nu run help See all the commands you can pass to the run script
nu run install Install giti, edi, rc to ~/.cargo/bin
nu run build Build
nu run clean Clean
nu run test Run tests
nu run clippy Run clippy
nu run log View the log output. This video has a walkthrough of how to use this.
nu run docs Build docs
nu run serve-docs Serve docs over VSCode Remote SSH session
nu run rustfmt Run rustfmt

The following commands will watch for changes in the source folder and re-run:

Command Description
nu run watch-all-tests Watch all test
nu run watch-one-test <test_name> Watch one test
nu run watch-clippy Watch clippy
nu run watch-macro-expansion-one-test <test_name> Watch macro expansion for one test

There's also a run script at the top level folder of the repo. It is intended to be used in a CI/CD environment w/ all the required arguments supplied or in interactive mode, where the user will be prompted for input.

Command Description
nu run all Run all the tests, linting, formatting, etc. in one go. Used in CI/CD
nu run build-full This will build all the crates in the Rust workspace. And it will install all the required pre-requisite tools needed to work with this crate (what install-cargo-tools does) and clear the cargo cache, cleaning, and then do a really clean build.
nu run install-cargo-tools This will install all the required pre-requisite tools needed to work with this crate (things like cargo-deny, flamegraph will all be installed in one go)
nu run check-licenses Use cargo-deny to audit all licenses used in the Rust workspace

Dependencies

~22–38MB
~492K SLoC