https://github.com/twpayne/forge
A simple utility to clone and open local and remote git repos.
https://github.com/twpayne/forge
cli git go gui vscode
Last synced: 8 months ago
JSON representation
A simple utility to clone and open local and remote git repos.
- Host: GitHub
- URL: https://github.com/twpayne/forge
- Owner: twpayne
- License: mit
- Created: 2024-01-15T03:39:25.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2025-01-09T00:47:28.000Z (over 1 year ago)
- Last Synced: 2025-02-07T00:41:28.196Z (over 1 year ago)
- Topics: cli, git, go, gui, vscode
- Language: Go
- Homepage:
- Size: 127 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# forge
forge is a simple utility to clone and open local and remote git repos.
forge is primarily designed for my personal workflow, but might be useful to
others who use VSCode, work on multiple GitHub projects, and use VSCode's Remote
SSH extension. There are certainly many bugs.
## Installation
Run:
```console
$ go install github.com/twpayne/forge/cmd/forge@latest
$ go install github.com/twpayne/forge/cmd/forge-gui@latest
```
## Command line interface
forge [flags] [remote:]pattern
`pattern` can be either `repo`, `owner/repo`, or `forge/owner/repo`.
Other flags control the action taken:
| flag | Action |
| - | - |
| none | Open the working copy in VSCode |
| `-c` | Clone the repo if it does not exist |
| `-s` | Open the working copy in a shell |
| `-w` | Open the project's repo in your web browser |
| `-d` | Open the project's documentation on pkg.go.dev in your web browser |
## Graphical user interface
`forge-gui` is a simple GUI using [Fyne](https://fyne.io/). It is designed to be
launched from a shortcut key (I use `CapsLock+J` with [this Hammerspoon
config](https://github.com/twpayne/dotfiles/commit/68a9663f5ae52c7347bf6a063438e1f5a457182a)).
Shortcuts:
| Key | Action |
| ------------------ | ------------------------------------------------------------------ |
| `Escape` | Quit |
| `Enter` or `Alt+C` | Open the working copy in VSCode |
| `Alt+S` | Open the working copy in a shell |
| `Alt+W` | Open the project's repo in your web browser |
| `Alt+P` | Open the project's documentation on pkg.go.dev in your web browser |
## License
MIT