Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ramirezfernando/ube
A command line tool used to count lines of code
https://github.com/ramirezfernando/ube
bubbletea cli cloc command-line-tool go goreleaser
Last synced: 3 months ago
JSON representation
A command line tool used to count lines of code
- Host: GitHub
- URL: https://github.com/ramirezfernando/ube
- Owner: ramirezfernando
- License: mit
- Created: 2024-03-27T16:52:17.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-07-28T22:46:07.000Z (5 months ago)
- Last Synced: 2024-07-30T02:43:19.453Z (5 months ago)
- Topics: bubbletea, cli, cloc, command-line-tool, go, goreleaser
- Language: Go
- Homepage:
- Size: 3.13 MB
- Stars: 15
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- charm-in-the-wild - ube - A lines of code counter. (_built with Bubble Tea_) (Applications / Development Tools)
README
# Ube
[](https://github.com/ramirezfernando/ube/releases/tag/v2.0.0)
Ube (ooh-bay) is a program that displays statistics about your code. Ube will show the number of files, and total lines within those files grouped by language.
## Example
## Table of Contents
- [Features](#features)
- [Installation](#installation)
- [macOS](#macos)
- [Linux](#linux)
- [Windows](#windows)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
## Features
- Ube has a huge range of languages, supporting over **220** language extensions.
- It's **accurate**, and **consistent** as it counts the number of newline characters `/n` present in a specified path. This ensures consistency across different platforms and text editors.
- The code statistics are displayed in a **clean**, **easy-to-read** format leveraging the following libraries:
- [Bubble Tea](https://github.com/charmbracelet/bubbletea) - A powerful little TUI framework
- [Bubbles](https://github.com/charmbracelet/bubbles) - TUI components for Bubble Tea
- [Lip Gloss](https://github.com/charmbracelet/lipgloss) - Style definitions for Bubble Tea
- [Log](https://github.com/charmbracelet/log) - A minimal, colorful Go logging library
- [Cobra](https://github.com/spf13/cobra) - A Commander for modern Go CLI interactions
### macOS
1. Download the appropriate release archive for your platform from the [Latest Release](https://github.com/ramirezfernando/ube-cli/releases) page:
- For Intel-based Macs: [ube_2.1.0_darwin_amd64.tar.gz](https://github.com/ramirezfernando/ube/releases/download/v2.1.0/ube-cli_2.1.0_darwin_amd64.tar.gz)
- For Apple Silicon Macs: [ube_2.1.0_darwin_arm64.tar.gz](https://github.com/ramirezfernando/ube/releases/download/v2.1.0/ube-cli_2.1.0_darwin_arm64.tar.gz)
2. Extract the archive from your downloads folder using the following command in your terminal:
```bash
# Use the name of your downloaded release archive
$ tar -xzf ~/Downloads/example.tar.gz
```
3. Move the extracted binary to a directory in your PATH for convenient access from any directory:
```bash
$ mv ube /usr/local/bin/ube
```
4. Verify the installation (might have to allow in settings):
```
$ ube -v
```
### Linux
1. Download the appropriate release archive for your platform from the [Latest Release](https://github.com/ramirezfernando/ube-cli/releases) page:
- For 32-bit systems: [ube-cli_2.1.0_linux_386.tar.gz](https://github.com/ramirezfernando/ube/releases/download/v2.1.0/ube-cli_2.1.0_linux_386.tar.gz)
- For 64-bit systems: [ube-cli_2.1.0_linux_amd64.tar.gz](https://github.com/ramirezfernando/ube/releases/download/v2.1.0/ube-cli_2.1.0_linux_amd64.tar.gz)
- For ARM 64-bit systems: [ube-cli_2.1.0_linux_arm64.tar.gz](https://github.com/ramirezfernando/ube/releases/download/v2.1.0/ube-cli_2.1.0_linux_arm64.tar.gz)
2. Extract the archive from your downloads folder using the following command in your terminal:
```bash
# Use the name of your downloaded release archive
$ tar -xzf ~/Downloads/example.tar.gz
```
3. Move the extracted binary to a directory in your PATH for convenient access from any directory:
```bash
$ sudo mv ube /usr/local/bin/ube
```
4. Set the correct permissions for the binary:
```bash
$ sudo chmod +x /usr/local/bin/ube
```
5. Verify the installation:
```bash
$ ube -v
```
### Windows
1. Download the appropriate release archive for your platform from the [Latest Release](https://github.com/ramirezfernando/ube-cli/releases) page:
- For 32-bit systems: [ube-cli_2.1.0_windows_386.tar.gz](https://github.com/ramirezfernando/ube/releases/download/v2.1.0/ube-cli_2.1.0_windows_386.tar.gz)
- For 64-bit systems: [ube-cli_2.1.0_windows_amd64.tar.gz](https://github.com/ramirezfernando/ube/releases/download/v2.1.0/ube-cli_2.1.0_windows_amd64.tar.gz)
- For ARM 64-bit systems: [ube-cli_2.1.0_windows_arm64.tar.gz](https://github.com/ramirezfernando/ube/releases/download/v2.1.0/ube-cli_2.1.0_windows_arm64.tar.gz)
2. Extract the archive from your downloads folder using a tool like 7-Zip or WinRAR.
3. Move the extracted binary (ube.exe) to a directory included in your system's PATH environment variable for convenient access. Alternatively, you can run the tool from its extracted location.
4. Verify the installation:
```
$ ube -v
```
## Usage
```
Ube is a code statistics tool for your terminal.
Usage:
ube [path] [flags]
Examples:
$ ube /path/to/directory
$ ube /path/to/file.go
Flags:
-h, --help help for ube
-v, --version version for ube
```
## Contributing
Contributions are welcome! Please check the [Contributing Guidelines](CONTRIBUTING.md) for a few helpful tips!
## License
This project is licensed under the [MIT License](LICENSE).