{"id":15064310,"url":"https://github.com/loftwah/grabitsh","last_synced_at":"2025-04-10T11:51:17.860Z","repository":{"id":256398298,"uuid":"850184651","full_name":"loftwah/grabitsh","owner":"loftwah","description":"A powerful CLI tool for gathering and summarizing key information from Git repositories, enhancing developer productivity through automation and streamlined analysis.","archived":false,"fork":false,"pushed_at":"2025-01-24T11:54:51.000Z","size":7295,"stargazers_count":7,"open_issues_count":2,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-02T23:06:48.590Z","etag":null,"topics":["automation","chatgpt","claude","cli-tool","developer-tools","gather-tool","git","go","golang","llm","open-source","productivity","repository-analysis"],"latest_commit_sha":null,"homepage":"https://grabit.sh","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/loftwah.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-08-31T04:51:35.000Z","updated_at":"2025-01-24T11:54:04.000Z","dependencies_parsed_at":"2024-09-13T22:01:01.001Z","dependency_job_id":null,"html_url":"https://github.com/loftwah/grabitsh","commit_stats":null,"previous_names":["loftwah/grabitsh"],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/loftwah%2Fgrabitsh","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/loftwah%2Fgrabitsh/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/loftwah%2Fgrabitsh/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/loftwah%2Fgrabitsh/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/loftwah","download_url":"https://codeload.github.com/loftwah/grabitsh/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248215192,"owners_count":21066619,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["automation","chatgpt","claude","cli-tool","developer-tools","gather-tool","git","go","golang","llm","open-source","productivity","repository-analysis"],"created_at":"2024-09-25T00:15:13.734Z","updated_at":"2025-04-10T11:51:17.840Z","avatar_url":"https://github.com/loftwah.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Grabit.sh\n\n[DEMO VIDEO](https://www.youtube.com/watch?v=M6FjvHV1qak)\n\nGrabit.sh is a powerful command-line tool designed to quickly gather and summarize useful information from Git repositories. It provides developers with a comprehensive overview of a project's structure, Git information, important files, and more.\n\n![# Grabit sh Grabit sh is a powerful command-line tool designed to quickly gather and summarize useful information from Git repositories  It provides developers with a comprehensive overview of a p](https://github.com/user-attachments/assets/f1fb1602-88bc-4898-a3c4-dbbcf92a584e)\n\n## Features\n\n- Repository structure visualization\n- Git information summary (recent commits, branches, remotes, status)\n- Identification of important configuration files\n- Large file detection\n- File type summary\n- Recently modified files list\n- Project type detection\n- LLM-friendly output chunks for easy integration with AI models\n\n## Installation\n\n### Pre-built Binaries\n\nYou can download pre-built binaries for your platform from the [Releases](https://github.com/loftwah/grabitsh/releases) page or use `curl` for direct download.\n\n#### Linux\n\n1. Download the `grabitsh-linux-amd64` file from the latest release:\n\n   ```bash\n   curl -L -o grabitsh-linux-amd64 https://github.com/loftwah/grabitsh/releases/latest/download/grabitsh-linux-amd64\n   ```\n\n2. Make it executable:\n\n   ```bash\n   chmod +x grabitsh-linux-amd64\n   ```\n\n3. Optionally, move it to a directory in your PATH:\n\n   ```bash\n   sudo mv grabitsh-linux-amd64 /usr/local/bin/grabitsh\n   ```\n\n#### macOS\n\n1. Download the `grabitsh-darwin-amd64` file from the latest release:\n\n   ```bash\n   curl -L -o grabitsh-darwin-amd64 https://github.com/loftwah/grabitsh/releases/latest/download/grabitsh-darwin-amd64\n   ```\n\n2. Make it executable:\n\n   ```bash\n   chmod +x grabitsh-darwin-amd64\n   ```\n\n3. Optionally, move it to a directory in your PATH:\n\n   ```bash\n   sudo mv grabitsh-darwin-amd64 /usr/local/bin/grabitsh\n   ```\n\n#### Windows\n\n1. Download the `grabitsh-windows-amd64.exe` file from the latest release using a browser or:\n\n   ```bash\n   curl -L -o grabitsh-windows-amd64.exe https://github.com/loftwah/grabitsh/releases/latest/download/grabitsh-windows-amd64.exe\n   ```\n\n2. Optionally, rename it to `grabitsh.exe` for convenience.\n\n3. Add the directory containing the executable to your PATH environment variable.\n\n### Building from Source\n\nIf you prefer to build from source or want the latest development version:\n\n1. Ensure you have Go installed on your system.\n\n2. Clone the repository:\n\n   ```bash\n   git clone https://github.com/loftwah/grabitsh.git\n   ```\n\n3. Navigate to the project directory:\n\n   ```bash\n   cd grabitsh\n   ```\n\n4. Build the project:\n\n   ```bash\n   go build -o grabitsh\n   ```\n\n## Usage\n\nTo use Grabit.sh, navigate to a Git repository directory and run the following command:\n\n```bash\ngrabitsh --output \u003coutput_method\u003e\n```\n\nReplace `\u003coutput_method\u003e` with one of the following options:\n\n- `stdout`: Display the output in the terminal (default)\n- `clipboard`: Copy the output to your clipboard\n- `file`: Save the output to a file (use the `-f` flag to specify the file path)\n- `llm-chunks`: Generate LLM-friendly chunks of the output (new feature)\n\n### Examples\n\n1. Display output in the terminal:\n\n   ```bash\n   grabitsh --output stdout\n   ```\n\n2. Copy output to clipboard:\n\n   ```bash\n   grabitsh --output clipboard\n   ```\n\n3. Save output to a file:\n\n   ```bash\n   grabitsh --output file -f output.txt\n   ```\n\n4. Generate LLM-friendly chunks:\n\n   ```bash\n   grabitsh --output llm-chunks\n   ```\n\n   This will create multiple text files, each containing a portion of the output with a preamble suitable for use with Large Language Models.\n\n5. Customize chunk size for LLM output:\n\n   ```bash\n   grabitsh --output llm-chunks --chunk-size 50000\n   ```\n\n   This sets the chunk size to 50,000 tokens. The default is 100,000 tokens.\n\n### LLM-Chunks Feature\n\nThe LLM-chunks output method is designed to create AI-friendly chunks of the Grabit.sh output. Each chunk includes a preamble that provides context about the tool, its purpose, and instructions for the AI model. This feature is particularly useful when you want to analyze the output using a Large Language Model or other AI tools.\n\nKey points about LLM-chunks:\n\n- Each chunk is saved as a separate text file (`grabitsh_chunk_1.txt`, `grabitsh_chunk_2.txt`, etc.).\n- The default chunk size is 100,000 tokens, which can be customized using the `--chunk-size` flag.\n- The preamble in each chunk helps the AI understand the context and purpose of the information.\n- This feature makes it easy to feed the Grabit.sh output into AI models for further analysis or to generate insights about the repository.\n\n## Web Server\n\nGrabit.sh also includes a web server feature. To start the web server, use the following command:\n\n```bash\ngrabitsh serve\n```\n\nThis will start a web server on port 42069. You can access it by navigating to `http://localhost:42069` in your web browser.\n\n## Future Development\n\n### Expansion Plans\n\nGrabit.sh is evolving beyond its current CLI functionality to include web-based capabilities. The following features and versions are planned for future releases:\n\n1. **Free Hosted Version (Public Repositories)**\n\n   - A web-based platform where users can input public Git repository URLs (GitHub, GitLab, Gitea, etc.).\n   - The system will scan the repository online and generate summaries and documentation similar to the CLI version.\n   - This version will be completely free for all users working with public repositories.\n\n2. **Paid Hosted Version (Private Repositories)**\n\n   - A subscription-based model designed for users who need to analyze private repositories.\n\n   - Offers advanced features such as:\n\n     - Priority processing\n     - Enhanced security protocols\n     - Team collaboration tools\n     - Multi-repo management\n\n   - The pricing will be tiered based on the number of repositories and users, with options for monthly or annual subscriptions.\n\n### Key Benefits\n\n- **Time Efficiency**: Quickly identifies essential files and generates necessary documentation, saving significant time for developers and teams.\n- **User-Friendly**: Offers both CLI and web-based interfaces to cater to different user preferences.\n- **Integration and Flexibility**: Compatible with any Git platform and supports multiple repositories.\n- **Comprehensive Free Options**: Open-source CLI and free hosted options encourage widespread adoption, while the paid model is ideal for monetizing private, enterprise usage.\n\n### Requirements for Future Versions\n\n- Users will need to bring their own OpenAI API key to utilize the LLM features, which adds flexibility and reduces operating costs for the service.\n\n## Project Structure\n\n```go\ngrabit.sh/\n├── cmd/\n│   └── grabitsh/\n│       ├── root.go\n│       ├── serve.go\n│       └── project_detection.go\n├── main.go\n├── go.mod\n├── go.sum\n├── LICENSE\n├── README.md\n└── .gitignore\n```\n\n## Contributing\n\nContributions to Grabit.sh are welcome! Please feel free to submit a Pull Request.\n\n## License\n\nThis project is licensed under the terms of the license included in the [LICENSE](LICENSE) file.\n\n## Contact\n\nFor any queries or suggestions, please open an issue on the GitHub repository.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Floftwah%2Fgrabitsh","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Floftwah%2Fgrabitsh","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Floftwah%2Fgrabitsh/lists"}