Getting Started

Learn how to install and start using ZFish in your Rust projects.

Installation

Using cargo add

The easiest way to add ZFish to your project

Terminal

cargo add zfish

Output

    Updating crates.io index Adding zfish v0.1.10 to dependencies

Your First App

Hello World

Create a simple colored output application

main.rs

use zfish::{style::Color, print};

fn main() {
    print("Hello, ", Color::Green);
    print("ZFish!", Color::Blue.bold());
    println!(); // New line
}

Output

Hello, ZFish!

View Full Example Source Code

Core Concepts

Colors & Styles

ZFish provides rich terminal coloring with 16 colors, 256 colors, and true color support.

Colors Example

use zfish::style::Color;

// Basic colors
print("Red text", Color::Red);
print("Green text", Color::Blue.bold());

// Styles
print("Bold text", Color::Blue.bold());
print("Italic text", Color::Yellow.italic());

Output

Red textGreen textBold textItalic text

Progress Bars

Create beautiful progress bars with multiple styles and real-time updates.

Progress Bar Example

use zfish::progress::Progress;

let mut progress = Progress::new(100);
progress.set_message("Processing...");

for i in 0..=100 {
    progress.set_position(i);
    std::thread::sleep(std::time::Duration::from_millis(50));
}

progress.finish_with_message("Done!");

Output

[========================================] 100.0% (100/100) Processing... Done!

Next Steps

Examples

Explore 18 comprehensive examples covering all ZFish features.

View Examples

Components

Learn about all available components and their APIs.

Browse Components

API Reference

Complete API documentation for all ZFish modules.

View API Docs

📋 Roadmap & Status

See what's implemented and what's coming in future releases.

View on Notion