Skip to content

Commit 96efac8

Browse files
committed
Adding experimental features page
1 parent 1bafcc6 commit 96efac8

File tree

2 files changed

+80
-0
lines changed

2 files changed

+80
-0
lines changed

_images/gkc-commit-message-ai-gen.gif

1.6 MB
Loading
Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
---
2+
3+
title: Experimental Features
4+
description: Learn about experimental features that are being worked on for possible future inclusion into GitKraken Client.
5+
taxonomy:
6+
category: gitkraken-client
7+
8+
---
9+
10+
Coming from the icy depths of the git ocean are GitKraken Client experimental features. These are ideas we are trying out that still have alot of work ahead, but that we want to share with the world sooner.
11+
12+
---
13+
14+
## Experimental Features
15+
16+
Navigate to <i class="fas fa-cog"></i><kbd><strong>Preferences</strong><i class='fa fa-caret-right'></i><strong>Experimental<strong></i></kbd> to access the experimental features menu.
17+
18+
19+
The features listed here are still under development and are provided to give you an early look at some of the new functionality we're working on at GitKraken. Experimental features may not work as intended and could be changed or removed in the future. These settings are entirely optional, so if you run into any issues, you can turn them off at any time.
20+
21+
If you do experience issues, or have any other feedback, please reach out to our team at the link below to help us improve GitKraken Client
22+
23+
### Git Executable
24+
25+
When this setting is enabled, GitKraken will utilize the Git executable instead of the NodeGit library for certain Git actions including fetching and committing. This may provide increased performance and compatibility with certain projects and development environments. This is a partial implentation and will only effect some aspects of Git within GitKraken - the amount of git commands using the git executable will increase with each release.
26+
27+
**Use Git Executable:** ☑ turn on this experimental feature! As soon as you check the box it is working.
28+
29+
**Git Executable:** We automatically include git with GitKraken. You can select other from other versions that are installed on your system.
30+
31+
##### Features using the Git Executable
32+
33+
Find below a list of features using the Git binary if the Git Executable experimental setting is enabled. Anything not listed is still using LibGit2/NodeGit paths.
34+
35+
**Added in 9.4.0:**
36+
- refresh commits (some of the commit info displayed in the graph)
37+
- verify commit gpg signature
38+
- commit
39+
- fetch
40+
- branch ahead/behind count (e.g. from pull request panel)
41+
- merge base calculation (e.g. from right clicking a local branch in the left panel)
42+
- branch rename
43+
- branch delete (local branch only)
44+
45+
### AI Commit Message Generation
46+
47+
With this setting enabled, GitKraken will have the ability to generate commit messages from any staged changes. You can access this feature from the Command Palette (⌘P/Ctrl P, or the magic wand icon () in the toolbar), or you can click the sparkle icon () in the commit panel when you have staged changes.
48+
49+
<div class='callout callout--danger'>
50+
<p> This feature requires sending a diff of your code changes to OpenAI. Ensure your code does not contain sensitive information before generating a commit message.</p>
51+
</div>
52+
53+
**Generate Commit Messages with AI:** ☑ turn on this experimental feature! As soon as you check the box it is working.
54+
55+
**OpenAi Api Key:** Your key generated by OpenAI. GitKraken Client uses `gpt-3.5-turbo` model for generating commit messages
56+
57+
**Prompt:** This is what is sent to OpenAI. We have it pre-filled to hopefully get Open AI on the right track. However, you can enter whatever you want here and it will be sent when you click ✨
58+
59+
#### How to use in GKC
60+
61+
Once you have AI commit message generation enabled you will see ✨ sparkles ✨ in the commit message field. Stage your changes and click this button to get the AI magic started!
62+
63+
<img src='/wp-content/uploads/gkc-commit-message-ai-gen.gif' class='img-bordered img-responsive center'>
64+
65+
Once the commit message has been generated, you can still fully edit the message before committing. You can also click the ✨to have OpenAI try again.
66+
67+
<div class='callout callout--danger'>
68+
<p> Be aware that using OpenAI/chatGPT has a cost. At the time of this writing it is $.10 per message, and with a trial account you get $5.00 free to start.</p>
69+
</div>
70+
71+
#### More about OpenAI
72+
73+
First, go here to login or create an account:
74+
https://chat.openai.com/auth/login
75+
76+
Next you can visit OpenAI's verview and documentation pages to learn more about how it works:
77+
https://platform.openai.com/
78+
79+
To specifically generate an API key for GitKraken to use navigate to:
80+
https://platform.openai.com/account/api-keys

0 commit comments

Comments
 (0)