https://github.com/acidghost/gabber
Repository 2 editor, at high BPM
https://github.com/acidghost/gabber
git-clone git-subcommand github tmux
Last synced: 13 days ago
JSON representation
Repository 2 editor, at high BPM
- Host: GitHub
- URL: https://github.com/acidghost/gabber
- Owner: acidghost
- Created: 2025-02-03T06:21:36.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-22T10:50:52.000Z (about 1 year ago)
- Last Synced: 2025-03-22T11:29:58.057Z (about 1 year ago)
- Topics: git-clone, git-subcommand, github, tmux
- Language: Python
- Homepage:
- Size: 46.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Gabber
[](https://github.com/acidghost/gabber/releases)
[](LICENSE)
[](https://github.com/acidghost/gabber/actions/workflows/ci-swift.yaml)
[](https://github.com/acidghost/gabber/actions/workflows/ci-ext.yaml)
> **:octocat: Repository to `$EDITOR`, at high BPM**
## Description
Gabber provides instant access to GitHub repositories from your browser with
automatic cleanup. This tool combines a browser extension with a macOS app to
streamline the workflow of temporarily cloning and editing repositories. Perfect
for quick contributions, code reviews, or exploring projects without cluttering
your local filesystem.
## Quick start
1. Install the browser extension and macOS app from
[releases](https://github.com/acidghost/gabber/releases)
2. Navigate to any GitHub repository
3. Click the Gabber button in your browser toolbar
4. Repository opens automatically in your configured editor
## Installation
### Browser extension
1. Download the latest extension package from
[releases](https://github.com/acidghost/gabber/releases)
2. Install in your browser (supports WebExtensions API)
3. The extension will add a button to your browser toolbar
### macOS app
1. Download `Gabber.dmg` from
[releases](https://github.com/acidghost/gabber/releases)
2. Mount the DMG and drag Gabber.app to Applications
3. Launch the app and follow the setup instructions
4. The CLI tool can be optionally installed via the app
Alternatively, build from source using [just](https://github.com/casey/just):
```bash
just install
```
## Usage
### Browser workflow
1. Navigate to any GitHub repository page
2. Click the Gabber extension button
3. Repository is cloned to a temporary directory and opened in `$EDITOR`
### CLI usage
```bash
# Direct CLI usage
git-gabber https://github.com/owner/repo
# Works with various GitHub URL formats
git-gabber https://github.com/owner/repo/blob/main/file.js#L42
git-gabber git@github.com:owner/repo.git
```
### Code example
The extension converts GitHub URLs to `gabber://` protocol links:
```javascript
// Extension automatically transforms GitHub URLs
window.location.href = "gabber://github.com/owner/repo";
```
## Configuration
Gabber uses your system's `$EDITOR` environment variable. Set it to your
preferred editor:
```bash
export EDITOR="code" # VS Code
export EDITOR="vim" # Vim
export EDITOR="subl" # Sublime Text
```
No additional configuration files are required. Temporary directories are
automatically cleaned up after editing sessions.
## Contributing
Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for
guidelines on submitting issues and pull requests.
## License
This project is licensed under the GPL-3.0 License - see the [LICENSE](LICENSE)
file for details.
## Credits
Inspired by [git-peek](https://github.com/Jarred-Sumner/git-peek) and
[peek](https://github.com/Jarred-Sumner/peek) by Jarred Sumner.