https://github.com/iddev5/scafetch

A command line tool to display information about remote repositories
https://github.com/iddev5/scafetch

cli-app git zig ziglang

Last synced: 8 months ago
JSON representation

A command line tool to display information about remote repositories

• Host: GitHub
• URL: https://github.com/iddev5/scafetch
• Owner: iddev5
• License: mit
• Created: 2022-02-22T12:44:18.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-07-11T15:27:23.000Z (over 1 year ago)
• Last Synced: 2024-10-24T16:50:39.731Z (about 1 year ago)
• Topics: cli-app, git, zig, ziglang
• Language: Zig
• Homepage:
• Size: 79.1 KB
• Stars: 6
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# scafetch

[![CI](https://github.com/iddev5/scafetch/actions/workflows/ci.yml/badge.svg)](https://github.com/iddev5/scafetch/actions)

[![license](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE.md)

[![zig](https://img.shields.io/badge/zig-0.13.0-orange.svg)](https://ziglang.org)

Scafetch is a command-line tool to display information about your remote Git repositories in an aesthetic and visually pleasing way.

It currently supports fetching repository information from Github, Gitlab and Codeberg (Gitea).

![](.data/scafetch.png)

# Installation

## Releases

You can get the latest stable [release](https://github.com/iddev5/scafetch/releases) from Github.

## Arch Linux (AUR)

Install the community maintained [scafetch](https://aur.archlinux.org/packages/scafetch) package.

# Usage

You only need Zig master to compile.

Use zig to build:

```

zig build -Doptimize=ReleaseSafe

```

(You can optionally install it in a system or user wide directory for easier access, use the ``-p `` flag for convenience)

Then, run the application:

```

./zig-out/bin/scafetch ziglang/zig

```

where ``ziglang/zig`` is taken as an example repository address, and the host defaults to Github

It is also possible to explicitly state the host service name using ``-o `` flag. See ``--help`` for more information.  

Scafetch can additionally infer the host service from hints present in the given URL:

Host name | 1                      | 2                            | 3

----------|------------------------|------------------------------|---------------------------------

Github    | ``gh//`` | ``github//``   | ``github.com//``

Gitlab    | ``gl//`` | ``gitlab//``   | ``gitlab.com//``

Codeberg  | ``cb//`` | ``codeberg//`` | ``codeberg.org//``

# Todo

- More CLI flags, like opt out of coloring, what info to display etc.

- Authentication support

- Show an ASCII art of the primary language(?) of the repository

# License

scafetch is licensed under [MIT License](LICENSE)