README.md

Ube

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
• Installation
  • macOS
  • Linux
  • Windows
• Usage
• Contributing
• 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 - A powerful little TUI framework
  • Bubbles - TUI components for Bubble Tea
  • Lip Gloss - Style definitions for Bubble Tea
  • Log - A minimal, colorful Go logging library
  • Cobra - A Commander for modern Go CLI interactions

Installation

macOS

1. Download the appropriate release archive for your platform from the Latest Release page:

   • For Intel-based Macs: ube_2.1.0_darwin_amd64.tar.gz
   • For Apple Silicon Macs: ube_2.1.0_darwin_arm64.tar.gz

2. Extract the archive from your downloads folder using the following command in your terminal:

   # 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:

   $ 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 page:
   • For 32-bit systems: ube-cli_2.1.0_linux_386.tar.gz
   • For 64-bit systems: ube-cli_2.1.0_linux_amd64.tar.gz
   • For ARM 64-bit systems: ube-cli_2.1.0_linux_arm64.tar.gz
2. Extract the archive from your downloads folder using the following command in your terminal:

   # 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:

   $ sudo mv ube /usr/local/bin/ube

4. Set the correct permissions for the binary:

   $ sudo chmod +x /usr/local/bin/ube

5. Verify the installation:

   $ ube -v

Windows

1. Download the appropriate release archive for your platform from the Latest Release page:
   • For 32-bit systems: ube-cli_2.1.0_windows_386.tar.gz
   • For 64-bit systems: ube-cli_2.1.0_windows_amd64.tar.gz
   • For ARM 64-bit systems: 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 for a few helpful tips!

License

This project is licensed under the MIT License.