2024-01-11 21:52:52 +03:00
|
|
|
# [GitButler](https://gitbutler.com)
|
2023-02-03 18:23:13 +03:00
|
|
|
|
2024-01-11 21:52:52 +03:00
|
|
|
<img width="200px" src="https://app.gitbutler.com/assets/gb-logo-c5e20a2be4fe4a7d2dbc8b5c0048782608bb5dbc58b7343cd5e7a49183ff961e.svg" />
|
2023-01-31 17:55:57 +03:00
|
|
|
|
2024-01-11 21:52:52 +03:00
|
|
|
[![CI][s0]][l0] [![TWEET][s6]][l6]
|
2023-02-03 18:23:13 +03:00
|
|
|
|
2024-01-11 21:52:52 +03:00
|
|
|
[s0]: https://github.com/gitbutlerapp/gitbutler-client/actions/workflows/push.yaml/badge.svg
|
|
|
|
[l0]: https://github.com/gitbutlerapp/gitbutler-client/actions/workflows/push.yaml
|
|
|
|
[s6]: https://img.shields.io/twitter/follow/gitbutler?label=follow&style=social
|
|
|
|
[l6]: https://twitter.com/intent/follow?screen_name=gitbutler
|
2023-01-31 17:55:57 +03:00
|
|
|
|
2024-01-11 21:52:52 +03:00
|
|
|
**[GitButler](https://gitbutler.com) is a new approach to version control tooling, using Git as a backend**
|
2023-01-31 17:55:57 +03:00
|
|
|
|
2024-01-11 21:52:52 +03:00
|
|
|
It is an open source [Tauri](https://tauri.app/)-based
|
|
|
|
Git client. It's UI is written in [Svelte](https://svelte.dev/) using [TypeScript](https://www.typescriptlang.org)
|
|
|
|
and it's backend is written in [Rust](https://www.rust-lang.org/).
|
2023-01-31 17:55:57 +03:00
|
|
|
|
2024-01-11 21:52:52 +03:00
|
|
|
![gitbutler_client](https://github.com/gitbutlerapp/gitbutler-client/assets/70/89466226-fc0b-4d42-951c-67d95590e00c)
|
2023-02-03 18:23:13 +03:00
|
|
|
|
2024-01-11 21:52:52 +03:00
|
|
|
## Downloading a Build
|
2023-01-31 18:01:58 +03:00
|
|
|
|
2024-01-11 21:52:52 +03:00
|
|
|
You can download the newest client build from [our downloads page](https://app.gitbutler.com/downloads).
|
2023-02-03 12:36:51 +03:00
|
|
|
|
2024-01-11 21:52:52 +03:00
|
|
|
Currently we have builds for Mac and Linux. A Windows build is on the way.
|
2023-09-06 10:33:27 +03:00
|
|
|
|
2024-01-11 21:52:52 +03:00
|
|
|
## Why GitButler?
|
2023-09-06 10:33:27 +03:00
|
|
|
|
2024-01-11 21:52:52 +03:00
|
|
|
Git's user interface has hardly been touched for 15 years. While it was written
|
|
|
|
for Linux kernel devs sending patches to each other over mailing lists, most
|
|
|
|
modern developers have different workflows and needs.
|
2023-04-18 13:54:38 +03:00
|
|
|
|
2024-01-11 21:52:52 +03:00
|
|
|
GitButler aims to rethink the version control concept, while still storing data
|
|
|
|
in Git and being able to push trees to Git servers.
|
2023-04-18 13:54:38 +03:00
|
|
|
|
2024-01-11 21:52:52 +03:00
|
|
|
## Main Features
|
2023-04-18 13:54:38 +03:00
|
|
|
|
2024-01-11 21:52:52 +03:00
|
|
|
- **Virtual Branches**
|
|
|
|
- Organize work on multiple branches simultaneously, rather than constantly switching branches
|
|
|
|
- Automatically create new branches when needed
|
|
|
|
- **Easy Commit Management**
|
|
|
|
- Undo, Amend and Squash commits by dragging and dropping
|
|
|
|
- **GitHub Integration**
|
|
|
|
- Authenticate to GitHub to open Pull Requests, list branches and statuses and more
|
|
|
|
- **Easy SSH Key Management**
|
|
|
|
- GitButler can generate an SSH key to upload to GitHub automatically
|
|
|
|
- **AI Tools**
|
|
|
|
- Automatically write commit messages based on your work in progress
|
|
|
|
- Automatically create descriptive branch names
|
|
|
|
- **Commit Signing**
|
|
|
|
- Easy commit signing with our generated SSH key
|
2023-08-22 10:46:48 +03:00
|
|
|
|
2024-01-11 21:52:52 +03:00
|
|
|
## Documentation
|
2023-08-22 10:46:48 +03:00
|
|
|
|
2024-01-11 21:52:52 +03:00
|
|
|
You can find our end user documentation at: https://docs.gitbutler.com
|
2023-08-22 10:46:48 +03:00
|
|
|
|
2024-01-11 21:52:52 +03:00
|
|
|
## Bugs and Feature Requests
|
2023-08-22 10:46:48 +03:00
|
|
|
|
2024-01-11 21:52:52 +03:00
|
|
|
If you have a bug or feature request, feel free to open an [issue](https://github.com/gitbutlerapp/gitbutler-client/issues/new),
|
|
|
|
or [join our Discord server](https://discord.gg/wDKZCPEjXC).
|
2023-08-22 10:46:48 +03:00
|
|
|
|
2024-01-11 21:52:52 +03:00
|
|
|
## Contributing
|
2023-08-22 10:46:48 +03:00
|
|
|
|
2024-01-11 21:52:52 +03:00
|
|
|
So you want to help out? Please check out the [CONTRIBUTING.md](CONTRIBUTING.md)
|
|
|
|
document.
|
2023-08-22 10:46:48 +03:00
|
|
|
|
2024-01-11 21:52:52 +03:00
|
|
|
If you want to skip right to getting the code to actually compile, take a look
|
|
|
|
at the [DEVELOPMENT.md](DEVELOPMENT.md) file.
|