Skip to content

Latest commit

 

History

History
107 lines (73 loc) · 2.78 KB

README.md

File metadata and controls

107 lines (73 loc) · 2.78 KB
Raw

glee

Glee is a command-line utility that simplifies the management of Git's local exclude patterns. It provides an intuitive interface for manipulating the .git/info/exclude file, which functions similarly to .gitignore but remains entirely local and is not shared with the repository.

Learn more about .git/info/exclude in the Git documentation

Usage

# Add specific files to the exclude list
glee add filename1 filename2

# Add multiple files using a glob pattern
glee add *.txt

# Add a glob pattern itself to the exclude list (escaping the special character)
glee add \*.txt

# Remove specific files from the exclude list
glee remove filename1 filename2

# Remove multiple files using a glob pattern
glee remove *.txt

# Remove a glob pattern itself from the exclude list (escaping the special character)
glee remove \*.txt

# Display current entries in the exclude list
glee list

# Clear all entries from the exclude list
glee clear

# Open the exclude file in your default text editor
glee edit

# Display help and available commands
glee help

Installation

Using Homebrew (macOS and Linux)

If you have Homebrew installed, you can install glee using:

brew install vpukhanov/tools/glee

To update glee to the latest version:

brew upgrade glee

Using Go

If you have Go installed on your system, you can install glee directly using the go install command:

go install github.com/vpukhanov/glee@latest

This will download the source code, compile it, and install the glee binary in your $GOPATH/bin directory. Make sure your $GOPATH/bin is added to your system's PATH to run glee from anywhere.

From Releases

  1. Visit the Releases page of the repository.
  2. Download the archive for your operating system and architecture.
  3. Extract the archive:
    • On macOS: Double-click the .zip file or use unzip glee_*_Darwin_*.zip
    • On Linux: tar -xzf glee_*_Linux_*.tar.gz
    • On Windows: Extract the .zip file using File Explorer or a tool like 7-Zip
  4. Move the glee binary to a directory in your system's PATH.

Building from Source

To build glee from source:

  1. Clone the repository: 
    git clone https://github.com/vpukhanov/glee.git
  2. Navigate to the project directory: 
    cd glee
  3. Build the project: 
    go build
  4. (Optional) Move the resulting glee binary to a directory in your PATH.

Verifying Installation

After installation, you can verify that glee is installed correctly by running:

glee version

This should display the version of glee you have installed.

Questions?

If you have any questions or need further clarification, feel free to open an issue for discussion.