Skip to content

gabriele2000/Piko

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

48 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🧩 Piko

License Platform Status Rust Docs CI Crates.io Issues Pull Requests Last Commit

A minimal, customizable system information tool written in Rust — inspired by Neofetch.

📚 Documentation: Piko's Docs


✨ Overview

Piko is a lightweight and extensible command-line tool that gathers and displays system information in a customizable format. Inspired by tools like Neofetch, it offers a clean and flexible way to view details about your system — from OS to CPU, memory, and more.

🚀 Features

  • 📦 Operating System details
  • 🧠 CPU specifications
  • 💾 Memory usage
  • 🗃️ Disk usage
  • 🌐 Network info (WIP)
  • 🎛️ Customizable output layout (WIP)
  • 🐧 Cross-platform: Linux & macOS

🧱 Project Structure

piko/
├── src/
│   ├── main.rs           # Entry point
│   ├── system_info.rs    # Collects system info
│   ├── output.rs         # Output formatting
│   └── config.rs         # Config file parsing
├── config/
│   ├── default_config.toml  # Default layout config
│   └── README.md            # Configuration guide
├── Cargo.toml            # Build & dependency config
└── README.md             # Project documentation

🛠 Installation

Ensure you have Rust installed:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

Clone and build the project:

git clone https://github.com/Elxes04/piko.git
cd piko
cargo build --release

⚙️ Usage

After building, run the binary:

./target/release/piko

It will load your layout from:

config/default_config.toml

and display system info accordingly.

🧩 Configuration

Customize your output by editing:

config/default_config.toml

For a full list of configuration options and examples, check out:

📄 Documentation on Read the Docs

Or see the in-repo config/README.md

🤝 Contributing

Got an idea or improvement? Contributions are welcome!
Feel free to open an issue or submit a pull request 🚀

📄 License

Licensed under the MIT License.

About

`Piko` is a command-line application written in Rust that gathers and displays system information in a customizable format. Inspired by tools like Neofetch, this application allows users to view details about their operating system, CPU, memory usage, and more

Resources

License

Stars

0 stars

Watchers

0 watching

Forks

Packages

 
 
 

Contributors

Languages

  • Rust 100.0%