Docs

Beautiful and minimal terminal animations for your CLI projects.

Note: Flossum is designed for Node.js environments.

Installation

$ npm install flossum
$ npm install -g flossum

VS Code Extension

RECOMMENDED

Accelerate your development workflow with the official Flossum DevTools extension for Visual Studio Code.

Snippets

Type ftype, fspin, or fwave to instantly generate boilerplate code.

Hover Docs

Hover over any flossum function to see parameter details, types, and usage examples directly in your editor.

Install from VS Marketplace

Animations

Typewriter

Types text character by character.

flossum typeout "Hello World" -s 80
await flossum.typeOut("Hello World", 80);
Click "Run Preview" to start

Reverse Type

Reveals text starting from the end.

flossum reverse "Goodbye" -s 60
await flossum.reverseType("Goodbye", 60);
Click "Run Preview" to start

Wave

Animated wave effect with RGB colors.

flossum wave "Surfing" -d 3000
await flossum.wave("Surfing", { duration: 3000 });
Click "Run Preview" to start

Glitch

Digital distortion/glitch animation.

flossum glitch "System Failure" -d 2000 -s 15
await flossum.glitch("System Failure", { duration: 2000, steps: 15 });
Click "Run Preview" to start

Scramble

Decodes text from random characters.

flossum scramble "Decrypted" -d 2000
await flossum.scramble("Decrypted", { duration: 2000 });
Click "Run Preview" to start

Rainbow

Cycles text through the color spectrum.

flossum rainbow "Colors!" -d 3000
await flossum.rainbow("Colors!", { duration: 3000 });
Click "Run Preview" to start

Pulse

Color pulsing effect (Blue/Cyan).

flossum pulse "Energy" -d 2500
await flossum.colorPulse("Energy", 2500);
Click "Run Preview" to start

Spinner

Classic loading spinner.

flossum spinner "Loading..." -d 3000
await flossum.spinner("Loading...", 3000);
Click "Run Preview" to start

Progress Bar

Animated ASCII progress bar.

flossum progress -w 30 -d 2000
await flossum.progressBar({ width: 30, duration: 2000 });
Click "Run Preview" to start

Dots

Loading animation with cycling dots.

flossum dots "Thinking" -c 5
await flossum.dots("Thinking", { cycles: 5 });
Click "Run Preview" to start

Flash

Blinks text on and off.

flossum flash "Alert!" -f 6
await flossum.flash("Alert!", { flashes: 6 });
Click "Run Preview" to start

Type-Delete

Types text then deletes it.

flossum typeDelete "Typing..." -d 50
await flossum.typeDelete("Typing...", { delay: 50 });
Click "Run Preview" to start

Contributing

  • Fork the repo.
  • Create a branch: git checkout -b feature/name
  • Add your animation in flossum/lib/
  • Submit a Pull Request!