Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adamsol/gitquill
Cross-platform GUI for Git. Built with Monaco Editor and Electron.
https://github.com/adamsol/gitquill
client diff electron git graph gui monaco-editor
Last synced: 3 days ago
JSON representation
Cross-platform GUI for Git. Built with Monaco Editor and Electron.
- Host: GitHub
- URL: https://github.com/adamsol/gitquill
- Owner: adamsol
- License: mit
- Created: 2024-11-06T19:41:22.000Z (about 2 months ago)
- Default Branch: master
- Last Pushed: 2024-11-06T19:46:30.000Z (about 2 months ago)
- Last Synced: 2024-12-15T18:11:27.191Z (10 days ago)
- Topics: client, diff, electron, git, graph, gui, monaco-editor
- Language: Vue
- Homepage:
- Size: 627 KB
- Stars: 141
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
GitQuill
Cross-platform GUI for Git.
|  |  |
|-----------------------------------------|------------------------------------|
Unique features
---------------
* Edit files directly in the diff view.
* Quickly amend past commits with the rebase tool.
* Configure linking from commit messages to your issue tracker.
* Configure buttons to execute any Git command with a click.
Requirements
------------
* [Git](https://git-scm.com/) 2.23+
* [Node.js](https://nodejs.org/) 18+
Installation
-----------
```sh
npm install
npm run build
npm start
```
Notes
-----
* GitQuill has a custom mechanism for saving/restoring work-in-progress (WIP) using branches instead of traditional stashing; this is because Git's stashing has technical quirks that make it difficult to integrate consistently into the UI.
* If you start a rebase while having a file selected, GitQuill will revert the whole commit content in the index, while keeping it in the working tree, so that you can edit files without leaving the application.
* When a conflict is detected, GitQuill automatically resets the unmerged files, in order to avoid the special repository state that makes things complicated to handle. Conflict markers are still left to be manually resolved.
* GitQuill doesn't watch repository files for changes. Status is refreshed when application receives focus or when you perform a relevant action in the UI.
* GitQuill calls `git` commands directly. You can view all executed operations in the log files for each repository: `.git/.quill/app.log`.
Configuration
-------------
* Per-repository configuration file: `.git/.quill/config.json5`. Example:
```js
{
autolinks: [
['#(\\d+)', 'https://github.com/adamsol/GitQuill/issues/$1'],
],
custom_actions: [
{ icon: 'mdi-download-outline', label: 'Pull', command: ['pull'] },
{ icon: 'mdi-upload-outline', label: 'Push', command: ['push'], click_twice: true },
],
}
```
* Global, automatic configuration file (open repositories, UI layout, etc): `%AppData%/GitQuill/config.json` for Windows; see https://electronjs.org/docs/api/app#appgetpathname for other platforms.
Contributing
------------
Thank you for your interest in the project! I generally do not accept pull requests. The best way to contribute is to report a bug or suggest a feature via [Issues](https://github.com/adamsol/GitQuill/issues).