blame-detective-cli

README

Blame Detective CLI ✅

Empowering Developers to Track and Expose Code Alterations! 🕵️
Explore the docs

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Blame Detective is a highly efficient and user-friendly application designed to streamline the process of bug tracking and debugging in software development projects. By leveraging its powerful features, Blame Detective empowers developers to identify and resolve bugs quickly and effectively, saving valuable time and resources.

In the cli!

Prerequisites

• VSCode (or edit the file editor in /home/alex/Documents/blame-detective-cli/cmd/blamed.go)

Install

Linux

curl -L https://github.com/alexandrelam/blame-detective-cli/raw/main/linux-blamed -o "$HOME/.local/bin/blamed" && chmod +x "$HOME/.local/bin/blamed"

Mac ARM

curl -L https://github.com/alexandrelam/blame-detective-cli/raw/main/macos-blamed -o "$HOME/.local/bin/blamed" && chmod +x "$HOME/.local/bin/blamed"

Windows

curl no-windows-🤡

Uninstall

rm "$HOME/.local/bin/blamed" && rm -rf /tmp/blamed

Usage

Blame Detective offers a range of powerful features to streamline the bug tracking and debugging process. Here are some examples of how you can effectively use the application:

(back to top)

Options

• -from <from_commit_hash>: Specifies the starting commit hash for viewing the log.
• -since <since_date>: Specifies the starting date for viewing the log.
• -author : Specifies the author of the commits to filter.
• -to <to_commit_hash>: Specifies the ending commit hash for viewing the log (default: HEAD).
• -until <until_date>: Specifies the ending date for viewing the log (default: now).
• -editor : Specifies the text editor to use for displaying commit changes (default: code).

Example

View commits since a specific date by a particular authors:

blamed -since "2023-01-01"

blamed -since "2023-01-01 -ignore \.json"

blamed -since "2023-01-01" -author "Alexandre Lam\|John Doe"

View commits between two specific commit hashes:

blamed -from abc123 -to def456

Note

Either a starting commit hash (-f) or a starting date (-s) must be provided. If an ending date (-u) is not provided, it defaults to the current date. The script uses the git log command to generate the commit history. The commits and their changes are displayed using the specified text editor.

Roadmap

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

• Generate batch of whole.diff files
• Generate concurently diff folder from batched whole.diff files
• Cache query, generate folder name with a hash from the command
• Add .blamedignore config file
• Ignore big useless files
• Readd loading bar

(back to top)

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Project Link: https://github.com/alexandrelam/blame-detective-cli

(back to top)

Acknowledgments

• me

(back to top)