https://github.com/ugniljoz/shli

Rust crate for shell-like TUIs
https://github.com/ugniljoz/shli

cli rust-crate shell-prompt tui

Last synced: about 1 year ago
JSON representation

Rust crate for shell-like TUIs

• Host: GitHub
• URL: https://github.com/ugniljoz/shli
• Owner: UgnilJoZ
• Created: 2019-06-11T17:50:13.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2022-01-18T17:48:20.000Z (over 4 years ago)
• Last Synced: 2025-04-14T10:53:01.144Z (about 1 year ago)
• Topics: cli, rust-crate, shell-prompt, tui
• Language: Rust
• Size: 60.5 KB
• Stars: 5
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
[![Crates.io](https://img.shields.io/crates/v/shli.svg)](https://crates.io/crates/shli)

![Build Status](https://github.com/UgnilJoZ/shli/actions/workflows/rust.yml/badge.svg)

[![Documentation](https://docs.rs/shli/badge.svg)](https://docs.rs/crate/shli/)

[![dependency status](https://deps.rs/crate/shli/0.3.0/status.svg)](https://deps.rs/crate/shli/0.3.0)

# shli

Rust crate for shell-like TUIs

## Purpose

If you once saw nslookup, glusterfs or shelldap and admired their shell-like terminal interfaces, this might be a crate for you.

This crate provides basic building blocks for providing users of your software such an interface.

## Example usage

See `examples/simple.rs`.

A `cargo run --example simple` will run it.

You will see a prompt. Type p, and then press TAB.

```

> p

```

It will autocomplete to `print`, an example command! Now issue this:

```

> print Hello

```

It will print "Hello", which is not spectacular. If you now press the up key, you will be able to edit your last command.

With the left and right keys, the user is able to edit the current commandline.

## Documentation

https://docs.rs/shli/