yogesh-cmd

🎉 git-viewer - Easily Explore Your Git History

📥 Download Now

🚀 Getting Started

Welcome to the git-viewer README. This tool helps you visualize your Git logs in an easy-to-understand way. You can see branch graphs, view diffs, and filter commits. Follow these steps to install and run the application on your local machine.

🔗 Download & Install

1. Visit the Releases Page
   To get the latest version of git-viewer, visit this page to download. You will find the appropriate files there for your system.

2. Choose the Right File
   Select the package that matches your operating system. For Windows, macOS, or Linux, there will be different options available.

3. Download the File
   Click on the file to start the download.

4. Install Node.js and Git
   Before you can run git-viewer, make sure you have the following installed on your computer:
   • Node.js version 20 or higher. You can download it from Node.js official website.
   • Git installed on your machine. You can get it from Git official website.
5. Open Your Terminal or Command Prompt
   After installation, access your terminal (Mac/Linux) or Command Prompt (Windows).

🛠 Usage Instructions

Once you’ve downloaded and installed everything, you can easily run git-viewer using the following commands.

1. View the Current Directory
   To visualize the current directory, enter this command in your terminal:

   pnpm dlx git-viewer
   

2. View a Specific Repository
   If you want to view a specific repository, replace the path with your repository’s path. For example:

   pnpm dlx git-viewer ~/projects/my-app
   

3. Access the Viewer
   After running the command, open your web browser and navigate to:

   http://localhost:44100
   

   Here, you can see your branch graph, commit logs, and file diffs displayed visually.

✨ Features

git-viewer comes with several useful features:

• Branch Graph Visualization
  See your branches neatly laid out in a graph format.

• Browse Local and Remote Branches
  Explore all branches, making it easy to navigate.

• Search Commits
  Find specific commits using search filters by message, author, or SHA.

• View Diffs
  Look at the differences between changes in highlighted syntax.

• Filter Commits by Branch
  Easily narrow down the commits to your desired branches.

📋 System Requirements

To ensure a smooth experience, please meet the following requirements:

• Node.js 20 or higher
• Git installed

🤔 Frequently Asked Questions

How does git-viewer work?

git-viewer runs a local server that presents your Git history in your web browser. Once you run the application using the terminal, you can view your repositories directly.

Can I use it on any operating system?

Yes, git-viewer works on Windows, macOS, and Linux.

What if I get an error?

If you face issues during installation or running the application, please check that you have the correct versions of Node.js and Git installed. Make sure you have internet access too.

👩‍💻 Contributing

If you want to contribute to git-viewer, feel free to submit issues or pull requests on the GitHub repository.

📞 Support

For any help or questions about using git-viewer, please check the issue tracker or contact the maintainers through the repository.