https://github.com/xeyossr/citch

citch - fast system fetch written in c++ (nitch but c++)
https://github.com/xeyossr/citch

command-line cpp fastfetch fetch flashfetch linux neofetch system terminal

Last synced: 14 days ago
JSON representation

citch - fast system fetch written in c++ (nitch but c++)

• Host: GitHub
• URL: https://github.com/xeyossr/citch
• Owner: xeyossr
• License: gpl-3.0
• Created: 2024-11-20T23:51:15.000Z (about 2 months ago)
• Default Branch: main
• Last Pushed: 2024-12-17T13:49:13.000Z (23 days ago)
• Last Synced: 2024-12-17T14:36:44.425Z (23 days ago)
• Topics: command-line, cpp, fastfetch, fetch, flashfetch, linux, neofetch, system, terminal
• Language: C++
• Homepage:
• Size: 1.24 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


# `Citch`



  Fast system fetch written in 👑 C++ 👑






![preview](assets/preview.png)

![License](https://img.shields.io/github/license/xeyossr/citch?style=for-the-badge)

![Commits](https://img.shields.io/github/commit-activity/m/xeyossr/citch?style=for-the-badge)

![AUR](https://img.shields.io/aur/version/citch?style=for-the-badge)

![GitHub Repo stars](https://img.shields.io/github/stars/xeyossr/citch?style=for-the-badge)

![GitHub issues](https://img.shields.io/github/issues/xeyossr/citch?style=for-the-badge)

![GitHub pull requests](https://img.shields.io/github/issues-pr/xeyossr/citch?style=for-the-badge)

![GitHub release (latest by date)](https://img.shields.io/github/v/release/xeyossr/citch?style=for-the-badge)



**Citch** is a small and fastsystem fetch tool written fully in `C++`. If you're familiar with nitch (btw written in `Nim`), Citch is essentially its C++ version.

Why C++? Well, because I started learning C++ and couldn’t think of anything else, lmao




# Installation

If you are using Arch Linux or an Arch-based distribution, you can download `citch` from AUR:

```bash

yay -S citch

```

If you are not using an Arch-based distribution:

```bash

git clone https://github.com/xeyossr/citch.git

cd citch

mkdir -p build && cd build

cmake ..

make

sudo cp build/citch /usr/bin/citch

```

# Usage

```

citch

```

flags:

```

 -gc --gen-config   | generate config file

```




# Configuration

> Before doing these, you need to create a configuration file with the `--gen-config` flag.

### `~/.config/citch/config.json` - config file

```json

{

  "modules": {

    "banner": true,

    "colors": true,

    "distro": true,

    "hostname": true,

    "kernel": true,

    "memory": true,

    "packages": true,

    "shell": true,

    "uptime": true,

    "username": true

  }

}

```

# Building 📦

### 1) clone repo

```fish

git clone https://github.com/xeyossr/citch

```

### 2) change dir (cd) to `citch`

```fish

cd citch

```

### 3) build program with `g++`

```fish

g++ citch.cpp -o citch

```




# File architecture 📁

```fish

citch

├── citch.cpp

├── dist

│   └── citch

├── install.sh

├── LICENSE

├── modules

│   ├── banners.cpp

│   ├── fetch.h

│   └── json.hpp

└── README.md

3 directories, 8 files

```

# Thanks for ideas & examples 💬

- [nitch](https://github.com/ssleert/nitch)

- [pfetch](https://github.com/dylanaraps/pfetch/)

- [neofetch](https://github.com/dylanaraps/neofetch)