Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🍃 Spinn-rs

spinn-rs_demo.mp4

demo 1 demo 2

Spinn-rs(Spinners) is a simple rust project for navigating, exporting and playing TUI loading animations(also called spinners).

⭐ Features

  • Ability to load custom spinners from JSON(see spinners.json).
  • Simple UI to navigate between spinners.
  • Allows changing animation speed when previewing spinners.
  • Allows exporting spinners as List, Array or String.
  • Allows changing quotes used in when exporting as List and Array.
  • Allows both single-line & multi-line exports.

📦 Usage

  1. Clone the repository to your machine.
  2. Go inside the project directory/folder.
  3. Run cargo run.

Tip

You can use cargo run -- -h for viewing all the flags, export formats etc..

🧩 Commands

Usage: spinn-rs <spinner_name> <args>

Arguments:

  --export=<as>           Export format. See Expprt options.
  --help                  Shows this message.
  --interval=<ms>         Interval between each frame in miliseconds.
  --multiline=<bool>      Whether to export the output in multiple lines.
  --quote=<char>          Text to use for quoting strings when exporting.
  --source=<path>         Path to a JSON file containing spinners.
      
  -e=<as>                 Alias for --export.
  -h                      Alias for --help.
  -i=<ms>                 Alias for --interval.
  -m=<bool>               Alias for --multiline.
  -q=<char>               Alias for --quote.
  -s=<path>               Alias for --source.

Export options:

  array                   { "a", "b", "c" }
  list                    [ "a", "b", "c" ]
  string                  a b c
                          
  a                       Alias for 'array'
  l                       Alias for 'list'
  s                       Alias for 'string'

About

Spinn(e)rs for the terminal, now written in rust!

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages