onefetch README

The project's README from github.com/o2sh/onefetch. As one markdown file: README.md.

Onefetch - Command-line Git information tool

Onefetch logo

Crates.io Version GitHub Actions Workflow Status MSRV

Homepage | Installation | Documentation


Onefetch is a command-line Git information tool that displays project information and code statistics for a local Git repository directly in your terminal. The tool works completely offline with a focus on performance and customizability.

Screenshot 1 Screenshot 2

Installation

Onefetch is available on Linux, macOS, and Windows platforms. Binaries for Linux, Windows, and macOS are available on the release page.

Linux

macOS

brew install onefetch

Windows

winget install onefetch

Usage

onefetch /path/of/your/repo

Or

cd /path/of/your/repo
onefetch

Customization

Onefetch can be customized via command-line arguments to display exactly what you want, the way you want it: adjust the text styling, disable info lines, ignore files and directories, output in multiple formats (JSON, YAML), etc.

Frequently Asked Questions

Why isn't my language detected?

By default, onefetch only displays programming and markup languages. Languages classified as prose (like Org mode, Markdown, or Text) or data (like JSON, YAML, or TOML) are hidden unless you include them with --type.

onefetch --type programming markup prose data

Why do duplicate authors appear?

Onefetch reads authors from the Git history. If the same person committed with different names or emails, they may appear more than once.

To merge those entries, add a .mailmap file to the repository.

Contributing

Currently, onefetch supports more than 100 different programming languages; if your language of choice isn't supported, open an issue and support will be added.

Contributions are very welcome! See CONTRIBUTING for more info.

onefetch (o2sh/onefetch)

Searching Database…

12.1K ·GitHub
Что это такое?Onefetch — это инструмент командной строки, который выводит в терминал информацию о проекте и статистику кода для локального Git-репозитория.
Это самостоятельная CLI-утилита, а не библиотека?Да, это самостоятельный исполняемый файл для командной строки, который вы запускаете внутри Git-репозитория; это не библиотека и не приложение с графическим интерфейсом.
Как установить и запустить?Установите готовые бинарные файлы для Linux, macOS или Windows со страницы релизов или воспользуйтесь менеджерами пакетов для вашей платформы (например, репозиториями Ubuntu, Arch Linux, openSUSE); затем запустите 'onefetch' внутри Git-репозитория.
Нужно ли что-то кроме самого репозитория, чтобы это запустить?Никакие дополнительные аккаунты или сервисы не нужны; достаточно запустить его внутри локального Git-репозитория, и он полностью работает офлайн.
Почему он не определяет мой язык или показывает одного автора дважды?По умолчанию он показывает только языки программирования и языки разметки, скрывая текстовые и форматы данных, такие как Markdown или JSON, если не передать флаг --type; один и тот же автор появляется дважды, если он коммитил под разными именами или адресами почты, и это исправляется с помощью файла .mailmap.
Он отправляет данные репозитория куда-нибудь?Нет, он работает полностью офлайн и читает только локальные данные Git.
Сколько языков программирования он поддерживает?Onefetch на данный момент поддерживает более 100 языков программирования для определения и отображения.
Можно ли изменить, какая информация выводится, или формат вывода?Да, аргументы командной строки позволяют настроить оформление текста, отключить строки с информацией, игнорировать файлы и каталоги, а также выводить данные в формате JSON или YAML вместо стандартного вида в терминале.
Работает ли он с любым Git-репозиторием или только с определёнными языками?Он работает с любым локальным Git-репозиторием: автоматически определяет используемые языки и показывает статистику, например историю коммитов и участников, рядом с ASCII-логотипом.
What are similar projects?gitui, zoxide, cargo, git-ai, yazi, git-cliff, eza, vim-fugitive
Creator
o2sh
Size
30.5 MB
Stars
12.1K
Age
8y
Commits · 90 Days