golang-gsls

Get a quick overview of your Git repositories with gs, the cross-platform alternative to ls.
Explore the docs »

Report Bug · Request Feature

Table of Contents

• Table of Contents
• About The Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

The "gs" tool is a modified version of the traditional "ls" command in Unix-like operating systems. The primary goal of this tool is to provide a better overview of the contents of a directory, including the state of any Git repositories contained within. The idea for the tool came from the frustration of manually checking the state of Git repositories in each folder. This tool was created to simplify this process and make it more efficient. Instead of having to manually navigate to each Git repository, the "gs" tool provides a centralized and streamlined way to view the state of all Git repositories in a directory. With colorful and easy-to-read output, the "gs" tool is a must-have for any developer who regularly uses Git for version control.

Built With

• Go

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

Before you begin, make sure you have Go installed on your machine. You can check if you have Go installed by running the following command in your terminal:

go version

If Go is not installed, you can install it from the official website: https://golang.org/dl/

Installation

With Brew

brew tap non-existing-organization/golang-gsls
brew install gsls

Compile Go

To install the gs tool, follow these steps:

• Clone the repository to your local machine:

  https://github.com/non-existing-organization/golang-gsls.git

• Change into the project directory:

  cd golang-gsls

• Build the project:

    GOOS=linux GOARCH=amd64 go build -o ./bin/gs_linux_amd64 gs.go
    GOOS=darwin GOARCH=amd64 go build -o ./bin/gs_darwin_amd64 gs.go
    GOOS=windows GOARCH=amd64 go build -o ./bin/gs_windows_amd64.exe gs.go
    GOOS=linux GOARCH=arm go build -o ./bin/gs_linux_arm gs.go
    GOOS=linux GOARCH=arm64 go build -o ./bin/gs_linux_arm64 gs.go
    GOOS=windows GOARCH=386 go build -o ./bin/gs_windows_386.exe gs.go

The gs executable file will be generated in the project directory. You can now run the tool using the following command:

./gs

Usage

The gs tool can be used just like the ls command in your terminal. It will list the contents of the current directory and show the file mode, name, size, date, and Git state if the file is a Git repository.

To run the tool, simply type the following command in your terminal:

gs

The output will display the information for each file and directory in the current directory.

Roadmap

See the open issues for a list of proposed features (and known issues).

---

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

---

License

Distributed under the GPLv3 License. See LICENSE for more information.

Contact

John Stilia - stilia.johny@gmail.com

---

Acknowledgements

• GitHub Emoji Cheat Sheet
• Img Shields
• Choose an Open Source License
• GitHub Pages