Home

Awesome

Ube

<img width="100%" alt="Ube banner" src="./images/ube-banner.png"/>

Latest Release Coverage GitHub Downloads (all assets, all releases) GitHub License

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

ube-example

Table of Contents

Features <a name="features"></a>

Installation <a name="installation"></a>

macOS <a name="macos"></a>

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

  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 <a name="linux"></a>

  1. Download the appropriate release archive for your platform from the Latest Release page:
  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 <a name="windows"></a>

  1. Download the appropriate release archive for your platform from the Latest Release page:
  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 <a name="usage"></a>

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 <a name="contributing"></a>

Contributions are welcome! Please check the Contributing Guidelines for a few helpful tips!

License <a name="license"></a>

This project is licensed under the MIT License.