13 |
14 |
15 | Then click this green plus icon to add a project directory:
16 |
17 | 
18 |
19 | This will make it easier to access repos you store in this folder.
20 |
--------------------------------------------------------------------------------
/docs/start-here/integrations.md:
--------------------------------------------------------------------------------
1 | ---
2 |
3 | title: Integrations
4 | description: Integrating with remote services and issue trackers has never been easier.
5 |
6 | ---
7 |
8 | ## Remote repo integrations
9 |
10 | GitKraken Client allows you to connect many different services and platforms, making it easy to work with your remote repositories.
11 |
12 | - [GitHub](/integrations/github/)
13 | - [GitHub Enterprise](/integrations/github-enterprise/)
14 | - [GitLab](/integrations/gitlab/)
15 | - [GitLab Self-Managed](/integrations/gitlab-self-hosted/)
16 | - [Bitbucket](/integrations/bitbucket)
17 | - [Bitbucket Server](/integrations/bitbucket-server/)
18 | - [Azure DevOps](/integrations/visual-studio-team-services/)
19 |
20 | ## Issue tracker integrations
21 |
22 | GitKraken Client makes it easy to integrate with a wide variety of issue tracking and project management tools.
23 |
24 | - [Jira](/integrations/jira/)
25 | - [Jira Server](/integrations/jira-server/)
26 | - [GitKraken Boards](/integrations/boards/)
27 | - [Trello](/integrations/trello/)
28 | - [GitLab Issues](/integrations/gitlab-issues/)
29 | - [GitLab Self-Managed Issues](/integrations/gitlab-self-managed-issues/)
30 | - [GitHub Issues](/integrations/github-issues/)
31 | - [GitHub Enterprise Issues](/integrations/github-enterprise-issues/)
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Foundation of Git - Exercise Repository
2 |
3 | Welcome! This is the sandbox repository for the [Foundations of Git](https://learn.gitkraken.com) course. Use this repository for exercise lessons, or as a sandbox for your own exploration.
4 |
5 | ## Cloning with GitKraken Desktop
6 |
7 | 1. [Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo#forking-a-repository) the repo on GitHub
8 | 2. Download [GitKraken Desktop](https://gitkraken.com)
9 | 3. Connect with GitHub account (not required, but helpful)
10 | 4. From New Tab, click the "Clone a repo" button
11 | - If you connected with GitHub, select GitHub.com tab and use dropdown menu to select fork. Then clone to your machine.
12 | - If not connected with GitHub, use the "Clone with URL" option and paste the Clone URL from fork repo page on GitHub. Then clone to your machine.
13 |
14 | 5. Success! Refer back to [course lessons](https://learn.gitkraken.com) for exercises.
15 |
16 |
17 | ## Resetting the repo
18 |
19 | Each exercise will provide instructions on how to reset the repo to the previous state.
20 |
21 | However, to completely reset the repo back to its original state, consider deleting your GitHub fork and your local copy of the repository on your machine. Then follow the instructions above to fork and clone the repo once more.
22 |
--------------------------------------------------------------------------------
/docs/start-here/terminal.md:
--------------------------------------------------------------------------------
1 | ---
2 |
3 | title: Terminal Tab
4 | description: A Git-enhanced terminal experience with GitKraken’s powerful visual Git commit graph
5 | ---
6 |
7 | The Git Client includes a [terminal](/working-with-repositories/terminal), which allows users to use Git CLI commands as well as additional GitKraken CLI specific commands.
8 |
9 | ### Open a Terminal
10 |
11 | To get started open up a repository and click the Terminal button in the toolbar.
12 |
13 | 
14 |
15 | ---
16 |
17 | ### Commands to explore
18 |
19 | Once in the Terminal enter Git commands by starting with `git`.
20 |
21 | 
22 |
23 | You can also enter GitKraken CLI specific commands with `gk`.
24 |
25 | 
26 |
27 | ---
28 |
29 | ### More information
30 |
31 | For a list of GitKraken CLI commands and further information about the Terminal, explore the 
14 |
15 | The cherry pick action is also available from _Local_ on the left panel.
16 |
17 | Here, cherry pick grabs the changes from the commit referenced by the HEAD of that branch, and places them onto the branch currently checked out.
18 |
19 | 
20 |
21 | ***
22 | ### Additional Learning Git Resources:
23 |
24 | 
15 |
16 | ### What to do with a link
17 |
18 | The link is copied to your clipboard. You can paste anywhere to share with others, for example on a Jira issue or a Slack conversation.
19 |
20 | When you have a link shared with you, simply click and away you go!
21 |
22 | 
23 |
24 | Additional information:
25 |
26 | * If the link is to a branch, commit, or tag, and the repository is not open, GitKraken Client will attempt to open the repository.
27 | * If you do not have the repository cloned, GitKraken Client will ask if you want to clone the repository, take you to the clone modal, and autofill the clone information.
28 | * If you have multiple copies of a repository on your local machine GitKraken Client will prompt you asking which repository you want to open.
--------------------------------------------------------------------------------
/docs/working-with-commits/undo-and-redo.md:
--------------------------------------------------------------------------------
1 | ---
2 |
3 | title: Undo & Redo
4 | description: The secret menu to GitKraken Client. Learn more about the Command bar, Command Palette and general tips for working faster.
5 |
6 | ---
7 |
8 | Ever use the command line, hit the enter key and have that awful moment where you're not sure if something dreadful just happened? How often do you or your coworkers find yourselves wishing you could undo something in Git?
9 |
10 | GitKraken Client can undo many of these changes with a single click of the undo button.
11 |
12 | 
13 |
14 | The following actions can be undone in GitKraken Client:
15 |
16 | + Checkout
17 | + Commit
18 | + Discard
19 | + Delete branch
20 | + Remove remote
21 | + Reset branch to a commit
22 |
23 |
24 | You can also redo actions if you undo them by mistake.
25 |
26 |
27 | 
11 |
12 | Clicking on the file shows the LFS reference information:
13 |
14 | 
15 |
16 | Staging and committing LFS tracked files results in the reference files being saved to your local repo and the actual files being saved to your local LFS cache.
17 |
18 | Once your repo is pushed to an LFS-capable remote, the reference files will be saved to the remote repo and the actual files will be pushed to your specified LFS server.
19 |
20 | Most LFS actions, such as Checkout, Fetch, Pull, and Push will happen automatically as you use the standard commands in GitKraken Client. However, if you want to use an LFS command in isolation, use the LFS toolbar menu:
21 |
22 | 
23 |
24 | Click the arrow on the button and select the desired command. Other than _Prune_, all of the commands are run by GitKraken Client via the traditional operations.
25 |
26 | 
13 |
14 | 
Hide
18 |Hides the selected branch from the graph.
19 | 20 |To hide a branch, mouse over that branch, and you will see the eye icon appear to the left of the branch name; click this to hide. 21 | 22 | Or perform this task by right-clicking the branch and selecting `Hide`.
23 |Hidden branches will now have a gray eye icon. Clicking this will restore that repo to the graph.
24 |
Solo
28 |Soloing a branch will hide all other branches which have not been soloed, showing only soloed branches.
29 |To solo a branch, right-click the branch and select `Solo`. This initiates Solo Mode, with soloed branches highlighted in orange and with a solid orange icon to the left of the branch name.
30 |Solo/unsolo additional branches by clicking on the semi-opaque icon to the left of that branch's name.
31 |Consider hiding/soloing entire remotes if you only need about two remotes, and then hiding everything else.
32 |
18 |
19 | You'll also find option to Show All Commits in Graph for those behemoth projects of yours.
20 |
21 | ## Search bar
22 |
23 | The search bar in the upper right of the application defaults to search for commits.
24 |
25 | 
26 |
27 | Search commits by message, SHA, or author and watch GitKraken Client update the results live.
28 |
29 | Iterating through the search results will take you to the commit in the graph. Consider using the Command Palette to search commits at any time too!
30 |
31 | 
18 |
19 | Once added, favorites will appear at the top of the drop-down menu in the main application. You can also right-click on any repo to favorite or unfavorite from here.
20 |
21 | 
22 |
23 | ## Shortcut Keys
24 |
25 | Once you have a repository favorited, you can quickly swap to it using the assigned keyboard shortcut. Up to 9 repositories can be assigned to the 1-9 keys:
26 |
27 | 
19 |
20 | Type the desired filename and hit Enter.
21 |
22 | 
23 |
24 | Folders can be created while creating a file by including a "/" in the file name.
25 |
26 | 
27 |
28 | ## Removing a file
29 |
30 | Delete a file from a previous commit by right clicking that file in the commit panel and selecting the `Delete file` context menu option.
31 |
32 | 
33 |
34 | Delete any file in the repo by ticking the `View all files` option, right clicking the file, and selecting the `Delete file` context menu option.
35 |
36 | 
37 |
38 | ## Filter files
39 |
40 | If you tick the `View all files` option, you'll gain access to the Filter Files bar. Use this to quickly jump to a specific file or to filter by a file type.
41 |
42 | 
--------------------------------------------------------------------------------
/docs/git-workflows-and-extensions/github-actions.md:
--------------------------------------------------------------------------------
1 | ---
2 |
3 | title: GitHub Actions
4 | description: GitHub Actions help you to automate your workflow
5 |
6 | ---
7 |
8 |
9 | 
26 |
27 | Hovering over `GitHub Actions` and clicking the button will open the `Create Workflow` panel. From here you can select from availible workflow templates or create a blank workflow. Workflows will be placed in the `.github/workflows folder` that GitHub uses (it will create the folder if none exists).
28 |
29 | 
40 |
41 | ***
42 |
43 | ###Delete Workflow
44 |
45 | You can quickly delete workflows by right-clicking on them and selecting `Delete-Workflow`.
46 |
47 | 
48 |
49 | ***
50 |
51 | ###GitHub Actions Documentation
52 |
53 | You can find examples and more information on 
16 |
17 |
18 | ## Open Command Palette
19 | * Use the keyboard shortcut ⌘P or CtrlP and begin typing.
20 | * Click the magic wand icon in the top right of the toolbar.
21 | * Navigate to the help menu Open Command Palette.
22 |
23 | ## Supported Commands:
24 |
25 | ### Repo
26 | * `Close Tab`
27 | * `Open Repo`
28 | * `Open in file manager`
29 | * `Open in External Editor`
30 | * `Open in External Diff/Merge Tool`
31 | * `Open in terminal`
32 | * `Repo Management: Clone`
33 | * `Repo Management: Init`
34 | * `Repo Management: Open`
35 |
36 | ### Settings
37 | * `Configure Git Flow`
38 | * `Configure LFS`
39 | * `Configure GPG Signing`
40 | * `Initialize LFS on this repo`
41 | * `Join the Light side` || `Join the Dark side`
42 | * `Manage Account`
43 | * `Settings`
44 | * `Switch to Profile` + `profile name`
45 |
46 | ### View
47 | * `Decrease Zoom`
48 | * `Increase Zoom`
49 | * `Keyboard Shortcuts`
50 | * `Open a new Terminal Tab`
51 | * `Reset Zoom`
52 | * `Toggle Left Panel`
53 | * `Toggle Commit Detail Panel`
54 | * `Toggle Syntax Highlighting`
55 | * `Toggle Theme`
56 |
57 | ### History
58 | * `Blame` + `filename`
59 | * `History` + `filename`
60 | * `Search Commits` + `message`/`sha`/`author`
61 |
62 | ### Core
63 | * `Redo`
64 | * `Undo`
65 |
66 | ### File
67 | * `Create File` + `filename`
68 | * `Delete File` + `filename`
69 | * `Open File` + `filename`
70 | * `View File` + `filename`
71 | * `Edit File` + `filename`
72 | * `Discard all changes`
73 | * `Stage all changes`
74 | * `Unstage all changes`
75 |
76 | ### Stash
77 | * `Stash: Apply`
78 | * `Stash: Create`
79 | * `Stash: Pop`
80 |
81 | ### Branch
82 | * `Create Branch`
83 | * `Create Tag`
84 | * `Create Annotated Tag`
85 | * `Fetch All`
86 | * `Pull`
87 | * `Push`
88 | * `Rename Branch`
89 | * `Start Pull Request`
90 | * `View Working Directory Changes`
91 |
92 | ### Checkout
93 | * `Checkout` + `{branch name}`
94 |
95 | ### Logs
96 | * `Activity logs`
97 | * `View Error Logs`
98 | * `View Performance Logs`
99 | * `View Release Notes`
100 |
--------------------------------------------------------------------------------
/docs/working-with-repositories/fork.md:
--------------------------------------------------------------------------------
1 | ---
2 |
3 | title: Forking GitHub Repos
4 | description: Fork your GitHub Repos using GitKraken Client.
5 |
6 | ---
7 |
8 | If you are using the [GitHub integration](/integrations/github/) or the [GitHub Enterprise integration](/integrations/github-enterprise/), then you may fork repos right from GitKraken Client.
9 |
10 | 
Remote in the left panel and click on the GitHub.com or the GitHub Enterprise tab.
19 |
20 | 
21 |
22 | If GitKraken Client does not detect an existing fork of this repo, the app will present the option to fork the repo and then add it as a remote.
23 |
24 | 
25 |
26 | Click to fork the repo on GitHub, and then add it as remote in GitKraken Client's left panel:
27 |
28 | 
29 |
30 | ## Add an existing fork
31 |
32 | Click the icon when hovering over 
37 |
38 | And remember, you can always [add a remote](/working-with-repositories/pushing-and-pulling/#adding-remotes) for any repo that is reachable over HTTPS or SSH.
39 |
40 |
41 |
42 |
--------------------------------------------------------------------------------
/docs/working-with-commits/squash.md:
--------------------------------------------------------------------------------
1 | ---
2 |
3 | title: Squash
4 | description: Squash commits to clean up your graph!
5 |
6 | ---
7 |
8 | 
24 |
25 | Clicking the squashed commit will display the commit message in the right panel. You can click on the commit message to amend it and consolidate all of the commit messages from your squashed commits.
26 |
27 | 
28 |
29 | ### Pushing a squashed commit
30 |
31 | In general, you should not push commits to your remote that you intend to squash, but what happens if you have already pushed them and you squash locally? Your local branch has the squashed commit, but your remote branch still has all of the commits.
32 |
33 | 
34 |
35 | When you push to your remote, you will receive a warning that your current branch is behind the remote branch. This is expected, because the HEAD of your current branch is no longer a descendent of the remote branch's HEAD.
36 |
37 | 
38 |
39 | In this instance, a will allow you to push the squashed commit to your remote and retain the clean history of your local branch.
40 |
41 | 
42 |
43 | You will see a warning letting you know that is a destructive action, but this is expected because we have rewritten our branch's history by squashing commits.
44 |
--------------------------------------------------------------------------------
/docs/working-with-commits/stashing.md:
--------------------------------------------------------------------------------
1 | ---
2 |
3 | title: Stash
4 | description: Save your changes for later with stashing in GitKraken Client.
5 |
6 | ---
7 |
8 | Let's talk about how to save your changes for later with stashing.
9 |
10 | ***
11 |
12 | 
19 |
20 | Your stash will appear on the graph. If you right click on the stash, you will be given the option to:
21 |
22 | * **Apply Stash**: Applies the changes to your WIP and retains stash for reusability
23 | * **Pop Stash**: Applies the changes to your WIP and then deletes your stash
24 | * **Delete Stash**: Annihilates a stash
25 | * **Hide**: Hides the selected stash from the commit graph
26 | * **Hide all stashes**: Hides all stashes from the commit graph
27 | * **Show all stashes**: Shows all stashes on the commit graph
28 |
29 | 
30 |
31 | If you only need to pop your stash, then use the Pop Stash button in the upper toolbar:
32 |
33 | 
34 |
35 | 
42 |
43 | This is helpful for those times you cannot find your stash on the graph.
44 |
45 | 
52 |
53 | The stash will now appear in the left panel and the graph with the desired name.
54 |
55 | 
56 |
57 | 
--------------------------------------------------------------------------------
/docs/working-with-repositories/interactive-rebase.md:
--------------------------------------------------------------------------------
1 | ---
2 |
3 | title: Interactive Rebase
4 | description: Learn about interactive rebase in GitKraken Client.
5 |
6 | ---
7 |
8 | Learn how to rewrite your commit history with interactive rebase in GitKraken Client.
9 |
10 | ***
11 |
12 | ## Initiating Interactive Rebase
13 | To initiate interactive rebase, drag and drop one branch onto another branch or right-click the target branch and select Interactive Rebase.
14 |
15 | 
16 |
17 | Right-click on any parent commit to see the interactive rebase option. However, please note that interactive rebase is not available for merge commits.
18 |
19 | ### Interactive rebase limits
20 |
21 | The drag and drop option will only show the interactive rebase option if:
22 |
23 | - No merge commits are present on the branch you’re rebasing
24 | - The 2 branches share a common ancestor
25 | - Neither branch has the repo’s initial commit
26 | - You are not attempting to rebase a parent branch onto a child (like master into a feature branch)
27 |
28 | 
40 |
41 | ### Reword
42 | When selecting reword you will see the Reword commit message modal open. Here you can edit the summary and description of your commit.
43 |
44 | 
45 |
46 | ### Squash
47 | When you squash you are taking the child commit and in turn writing that commit to the parent commit. In order for squash to be an option there will have to be a parent child relationship.
48 |
49 | 
50 |
51 | ### Drop commit
52 | Drop removes the commit from the branch, completes rebase and rewrites the commit graph.
53 |
54 | 
55 |
56 | ---
57 |
58 | ### Keyboard Shortcuts and Reset
59 | Use keyboard shortcuts Pick, Squash, Reword and Drop to perform commit actions. If you wish to start over, click .
60 |
61 | 
--------------------------------------------------------------------------------
/docs/working-with-repositories/tags.md:
--------------------------------------------------------------------------------
1 | ---
2 |
3 | title: Tags
4 | description: Designating important points of the Git history. Creating Tags in GitKraken Client on commits is easy with the graph.
5 |
6 | ---
7 |
8 | Tags 
are pointers to a commit. Some examples of these are for marking versions of your product or important changes.
9 |
10 | ***
11 | ### Adding tags
12 |
13 | To create a new tag in GitKraken Client, right click on the commit you'd like to tag, and select Create tag here at the bottom.
14 |
15 | 
16 |
17 |
18 | Tags are created locally, but available for remotes by right clicking the tag and selecting to push the tag to the remote.
19 |
20 | 
21 |
22 | Double click a tag in the left panel to jump to when the tag was added. Tags can also be hidden and soloed just like branches from the right click menu.
23 |
24 | 
25 |
26 | ***
27 |
28 | ### Checkout a tag
29 |
30 | While you cannot directly checkout a tag, right-click on a tag and choose the Create branch here to create and then immediately checkout the commit tied with the tag.
31 |
32 | 
33 |
34 | Alternatively, consider using the [detached HEAD state](/working-with-commits/detached-head-state/) to checkout the commit directly.
35 |
36 | ***
37 |
38 | ### Moving tags
39 | To move a tag to the branch HEAD, checkout the new branch, right click the tag, and select fast-forward.
40 |
41 | If a tag cannot be fast-forwarded, you can delete and then add a new one. Be sure to delete the tag on remote as well.
42 |
43 | ***
44 |
45 | ### Tag messages
46 | Create annotated tags by right clicking a branch or commit and selecting Create annotated tag here. You can annotate an existing tag by right clicking the tag and selecting Annotate tag. This message will be displayed when hovering over the tag in the left panel, or in the graph.
47 |
48 | 
49 |
50 | ### Search or filter tags
51 |
52 | You may filter tags from the filter bar in the left panel. Use this to quickly find a tag.
53 |
54 | 
--------------------------------------------------------------------------------
/docs/working-with-repositories/team-view.md:
--------------------------------------------------------------------------------
1 | ---
2 |
3 | title: Team View
4 | description: Working with the Team View in GitKraken Client.
5 |
6 | ---
7 |
8 | The Team View allows you to see what branches and files members of your organization are currently working on. This is helpful for avoiding and collaborating on merge conflicts.
9 |
10 | 
23 |
24 | Additional lines to their files will be shown in 
27 |
28 | Learn more about [how to create a team](https://support.gitkraken.com/start-here/teams/).
29 |
30 | ***
31 |
32 | ### Status
33 |
34 | The **status** will display on the avatars of members in your GitKraken Organization or Team, indicating if they are actively using GitKraken Client. This activity status icon is visible in the Team View section in the Left Panel, or in the Organization view in Preferences.
35 |
36 | 
37 |
38 | Users can manually set their **status** to “Active” or “Away” by selecting the circle icon in the top right corner, or by opening the Profile/Account dropdown menu.
39 |
40 | 
41 |
42 |
43 |
44 |
45 | ***
46 |
47 | ### Opt Out
48 |
49 | You may opt out of team sharing by toggling _Share work-in-progress status with my team_ under Preferences > General .
50 |
51 | 
--------------------------------------------------------------------------------
/docs/working-with-repositories/submodules.md:
--------------------------------------------------------------------------------
1 | ---
2 |
3 | title: Submodules
4 | description: Submodules allow you to include other Git repositories within another Git repository. Work with submodules in GitKraken Client.
5 |
6 | ---
7 |
8 | Submodules allow you to include other Git repositories within a Git repository and can be managed directly inside of GitKraken Client.
9 |
10 | 
Submodules in the left panel. Paste the HTTPS or SSH link to the repository, and then enter the path.
17 |
18 | 
19 |
20 | Adding a submodule to the repository adds a link to the submodule's repository in the 
31 |
32 | If you clone a repository that contains a submodule, you will be prompted to initialize the submodule. This will clone the submodule's repository and check out the referenced commit.
33 |
34 | ### Changing pointer commit
35 | To change the pointer commit, open the submodule in GitKraken Client and then check out the new commit. You may need to first create a branch on the target commit before you can check it out.
36 |
37 | Then when you exit the submodule, GitKraken Client will detect the change and ask you if you wish to save the change.
38 |
39 | 
40 |
41 |
42 |
43 | ### Statuses
44 | Below are possible statuses of your submodules and their remedies:
45 |
46 | - _Out of sync_ -- The checked out commit of the submodule has changed. There is a change to the submodule reference in your work in progress that should be stashed, committed or discarded.
47 |
48 | - _Added but not initialized_ -- Right click and select initialize.
49 | - _Added and initialized but not committed_ -- When adding a submodule, commit the submodule folder to the repository and insert the reference to the submodule in the 
18 |
19 | The checked out commit will be tagged as `HEAD`, serving as your indication that you’ve entered detached HEAD state.
20 |
21 | 
22 |
23 | You now have access to the full history of the commit.
24 |
25 | ### Leaving detached HEAD state
26 |
27 | Feel free to stay a while; you can look around, make some experimental changes and commit them, all without impacting other branches. The commits you make in this state are “detached” from the rest of your project’s development - so when you’re ready to discard the commits you’ve made in this state, simply checkout a branch.
28 |
29 | When you check out a branch, the `HEAD` tag indicator will disappear and your repo will be business as usual.
30 |
31 | 
32 |
33 | 
41 |
42 | ### Keeping your commits
43 |
44 | If you hit that stride and create changes in the detached HEAD state that you’d ultimately like to keep, you can easily do so by right clicking on your checked out commit and selecting Create branch here.
45 |
46 | 
47 |
48 | ### Recovering lost commits
49 |
50 | If you unintentionally checkout another branch, you can [Undo](https://support.gitkraken.com/working-with-commits/undo-and-redo/) to recover the commit. If you are unable to undo the change, these commits will still be tracked in the repository. Using the CLI, you can use [git reflog](https://git-scm.com/docs/git-reflog) to find the SHA of the missing commit and [git checkout 
20 |
21 | 
28 |
29 | Exit preferences to access two new things: an LFS button in the toolbar and an unstaged change to the `.gitattributes` file that needs to be committed.
30 |
31 | 
32 |
33 | Stage and commit the changes to the `.gitattributes` file to finish the LFS initialization.
34 |
35 | Existing files need to be untracked from Git and re-tracked to count as LFS files. Consider removing the files from the repository (Git will think they have been removed/deleted), commit, then re-add the files and re-commit.
36 |
37 | The re-added files should now follow your new LFS tracking pattern.
38 |
39 | ## Initializing LFS on a new repo
40 |
41 | When you initialize a new repository, you will have the option to _Initialize with LFS_.
42 |
43 | 
44 |
45 | ## Configuring LFS
46 |
47 | Once LFS is initialized on a repository, add tracking patterns to the `.gitattributes` file. These tracking patterns will tell LFS which files to monitor in your repository.
48 |
49 | 
50 |
51 | Access the `.gitattributes` file by going to Preferences LFS or by editing the `.gitattributes` file directly in your text editor.
52 |
53 | As another option, add tracking patterns to the repository’s `.gitattributes` file through the Unstage pane in the right panel.
54 |
55 | Select the WIP node, right click the file you wish to be tracked by LFS, and select the desired option under LFS.
56 |
57 | 
58 |
59 | 
18 |
19 | * Use the Edit File subcommand in the Command Palette.
20 | Hit Ctrl/Cmd + P, type `Edit File`, hit Enter, type the name of the file, and hit Enter.
21 |
22 | 
23 |
24 | * Click the from Diff/File View.
25 | 
26 | 
34 |
35 | IntelliSense suggestions are shown based on the extension of the file.
36 |
37 | 
38 |
39 | ### Saving edits
40 |
41 | The blue dot in the upper right corner indicates unsaved changes.
42 |
43 | 
44 |
45 | To save your changes, hit Ctrl/Cmd + S
46 |
47 | To exit the file without saving your changes, hover over the blue dot, click the `X`, and select `Don't Save`.
48 |
49 | 
50 |
51 | ### Staging edits
52 |
53 | Clicking the button with pending changes will give you the options to `Save and stage` or `Stage saved changes only`.
54 |
55 | 
--------------------------------------------------------------------------------
/docs/start-here/themes.md:
--------------------------------------------------------------------------------
1 | ---
2 |
3 | title: Themes
4 | description: Using and creating themes in GitKraken Client.
5 |
6 | ---
7 |
8 | # GitKraken Client Themes
9 |
10 | ***
11 |
12 | ## Built-in Themes
13 |
14 | You can set your GitKraken Client theme by navigating to Preferences UI Customization menu.
15 |
16 | This can also be done quickly from the [Command Palette](/start-here/command-palette/) (shortcut ⌘P or CtrlP), typing `switch theme`, and then the name of the theme.
17 |
18 | 
19 |
20 | ### Sync with System
21 |
22 | If your system is capabale of it, you can set GitKraken Client to match your operating system's current theme. This can be done from the Preferences UI Customization menu or the [Command Palette](/start-here/command-palette/).
23 |
24 | ***
25 |
26 | ## Custom Themes
27 |
28 | In addition to the default themes, GitKraken Client supports custom user-defined themes. Each of the .jsonc-default theme files you see in this folder can act as a template "base" for your new custom theme.
29 |
30 | ### Making Your Own Theme
31 |
32 | To make your own custom theme, follow these steps:
33 |
34 | 1. Make a copy of one of the default theme files you'd like to base your custom theme off of in this folder.
35 |
36 | 2. Rename your copied file to be `MyCustomTheme.jsonc` (i.e. drop the `-default` from the extension and give it a unique name).
37 |
38 | 3. Open your new theme file in a text editor.
39 |
40 | 4. Change the `meta.name` property of your theme file to be something unique (a good idea would be to match the file name). The `name` will be used as the display for the option under `Preferences > UI Customization > Theme` in `GitKraken`, so make it something you'll recognize. The scheme must be "light" or "dark", and will be used for default colors if anything is missing. If new properties are added in future releases, your theme will continue to work as-is, by using the scheme to choose a default color for the missing properties.
41 |
42 | 5. Back in `GitKraken`, find your new custom theme under `Preferences > UI Customization > Theme` and select it.
43 |
44 | 6. Edit the color values for any of the props under `themeValues`.
45 |
46 |
47 | 
23 |
24 | Under the Members section you may s to your Organization and use the search bar to search for members by name, username, or email.
25 |
26 | You may edit a users role or remove the user from the Organization by selecting the on the user.
27 |
28 | 
29 |
30 | If you do not have extra licenses while inviting a member, you will be prompted to purchase an additional license.
31 |
32 | 
33 |
34 | ***
35 |
36 | ### Managing a Team
37 |
38 | You may create a Team from the icon.
39 |
40 | 
41 |
42 | 
49 |
50 |
51 | You may rename a Team by double clicking the Team name.
52 |
53 | 
54 |
55 |
56 | #### Managing Users in a Team
57 |
58 | To add a user to a Team, select the Team and then select . Users can be removed from a Team by selecting the on the user.
59 |
60 | ***
61 |
62 | ### Suggested Members
63 |
64 | GitKraken Client will suggest users that contribute to the current repository that are not in your Organization. You may the member to your Organization to help future collaboration.
65 |
66 | 
--------------------------------------------------------------------------------
/docs/how-to-install.md:
--------------------------------------------------------------------------------
1 | ---
2 |
3 | title: How to Install GitKraken Client
4 | description: No Git tools are required for GitKraken Client, so once you’ve run the installer, you can open the app and get going.
5 |
6 | ---
7 |
8 | There are three steps to success with GitKraken Client. That's it!
9 |
10 | 1. [Download](https://gitkraken.com/download) GitKraken Client
11 | 2. Install GitKraken Client
12 | 3. Use GitKraken Client
13 |
14 | No Git tools are required for GitKraken Client, so once you’ve run the installer, you can open the app and get going.
15 |
16 | It works directly with your repositories with no dependencies—you don’t even need to have Git installed on your system. GitKraken Client is built with NodeGit, a Git framework that is primarily developed and maintained by members of the GitKraken development team.
17 |
18 | Below are platform-specific details on minimum requirements.
19 |
20 | 
45 |
46 | ### Data Location
47 | GitKraken Client data is stored in `/Users/{user}/.gitkraken` == `~/.gitkraken`.
48 |
49 | ***
50 | ## Linux (.deb, .rpm, and .tar.gz files)
51 | * **.deb system requirements:** Ubuntu 18.04 LTS or later
52 | * **.rpm system requirements:** RHEL 7+, CentOS 7+, or Fedora 34+
53 |
54 | 
21 |
22 | Activity Logs files are plain text in a standard log file format. Each line displays time of action, action feedback, and performance data measured in milliseconds.
23 |
24 | 
25 |
26 | Activity Logs collate Git actions, outputs information chronologically, and displays activity history indefinitely.
27 |
28 | ### Application Log
29 |
30 | The *Applications* tab in Activity Logs contains messages about actions made in GitKraken Client application. Discover events from your GitKraken Client instance such as: project creation, clearing SSH, setting global gitconfig, etc.
31 |
32 | 
33 |
34 | This tab information remains consistent regardless of the repository currently in focus: switching repositories will not alter the Application system log files.
35 |
36 | ### Repository Log
37 |
38 | The *Repository* tab in Activity Logs contains logged messages of Git operations taken while working with your repository.
39 |
40 | Refer to your *Repository* log to increase your project scope as a greater source of truth of your Git activity such as: fetch, push, merge, etc.
41 |
42 | 
43 |
44 | *Repository* activity reflects action taken in the repository currently open in focus.
45 |
46 | 
55 |
56 | ### Git Hook Log
57 |
58 | Do you automate your workflow with 
65 |
66 | You can also access a hook log from the snackbox notification that populates near the footer toolbar when an error is thrown.
67 |
68 | 
69 |
70 |
--------------------------------------------------------------------------------
/docs/git-workflows-and-extensions/git-flow.md:
--------------------------------------------------------------------------------
1 | ---
2 |
3 | title: Gitflow
4 | description: Gitflow is a list of rules to keep a repo’s history organized, and is used to make the release process, bug fixes, and feature creation easier.
5 |
6 | ---
7 |
8 | Gitflow is a list of rules to keep a repo’s history organized, and is used to make the release process, bug fixes, and feature creation easier.
9 |
10 | 
19 |
20 | Once initialized, two branches will always be present: `master` (The version in production) and `develop` (The version currently in development for the next release).
21 |
22 | Changes are merged into these branches. If you do not currently have these branches in your local repository, GitKraken Client will create them when Gitflow is initialized.
23 |
24 | ***
25 | ## Usage
26 | With Gitflow initialized in your repo, you will get an additional menu in the left panel. Start or finish any of your Gitflow branches here.
27 |
28 | 
29 |
30 | Create new Gitflow branches by clicking the green button on the Gitflow menu on the left.
31 |
32 | Or whenever you add a branch, include the prefix for the Gitflow branch type i.e.
33 | `feature/branch-name`. Any branches that do not have the prefix, will be displayed in the local
34 | repository section, but not in the Gitflow menu.
35 |
36 | 
37 |
38 | 
50 |
51 | You also have the option to rebase the `feature` branch on top of `develop`.
52 |
53 | ### Release
54 | Releases are major and minor versions of your product. They're often shared with other collaborators working on the same version.
55 |
56 | When finishing a release, the release branch is merged into both `master` and `develop` branches. This creates a tag with the release name for future reference.
57 |
58 | 
59 |
60 | ### Hotfix
61 | Hotfixes are the same as Releases in Gitflow, except hotfix branches are created on top of `master`, while release branches are created on top of `develop`.
62 |
63 | Hotfixes are for quickly pushing out a change to your production branch. Common examples of hotfixes are fixing typos, and bugs that need to be pushed out as soon as possible to production.
64 |
65 | When finishing a hotfix, GitKraken Client will merge the changes into both `master` and `develop`.
66 |
67 | 
68 |
--------------------------------------------------------------------------------
/docs/working-with-repositories/terminal.md:
--------------------------------------------------------------------------------
1 | ---
2 |
3 | title: Terminal Tab
4 | description: A Git-enhanced terminal experience with GitKraken’s powerful visual Git commit graph
5 |
6 | ---
7 |
8 | Open the terminal to use Git CLI commands while still viewing the graph.
9 |
10 | To get started open up a repository and click the terminal button in the toolbar, from the new tab view by clicking New Terminal Tab, or by searching for "terminal" in the 
28 |
29 | Auto-complete suggestions will also appear for flags.
30 |
31 | 
32 |
33 | 
41 |
42 | As well as suggestions for additional parameters.
43 |
44 | 
45 |
46 | Different views can be accessed using the `gk` CLI program:
47 |
48 | * `gk panel`: toggles the visualization panel. Also has parameters to reposition the panel top/bottom/left/right.
49 | * `gk graph`: shows the graph view. Same behavior as the `gk panel`, but additionally it will return to the graph if you're in a different view, and has subcommands for toggling the graph columns with the keyboard.
50 | * `gk history` and `gk blame`: opens the history/blame panel for a specific file.
51 | * `gk diff`: shows changes between commits. If no SHAs are provided, it will use your WIP and HEAD. If only one SHA is provided, it will be compared with HEAD.
52 | * `gk --help`: shows the list of `gk` commands.
53 |
54 | 
55 |
56 | ---
57 |
58 | ### Toolbar
59 |
60 | A toolbar above the panel will display the current repo name, branch, tag, and number of changes pending to pull/push. Clicking this toolbar will also toggle the panel on/off.
61 |
62 | 
63 |
64 | ---
65 |
66 | ### Terminal Preferences
67 |
68 | Navigate to Preferences Terminal to change your Terminal preferences.
69 |
70 | 
75 |
76 |
77 |
--------------------------------------------------------------------------------
/docs/start-here/profiles.md:
--------------------------------------------------------------------------------
1 | ---
2 |
3 | title: Profiles
4 | description: Create multiple profiles in GitKraken Client to quickly switch between repository preferences. Manage different gitconfig settings, repositories, and more!
5 |
6 | ---
7 |
8 | GitKraken Client uses profiles to store your app preferences, current [Tabs](/start-here/interface/#tabs), and Git config information.
9 |
10 | 
11 |
12 | 
20 |
21 | The _Keep my .gitconfig updated with my profile info_ option updates your global `.gitconfig` file with the name and email address of your current profile.
22 |
23 |
24 | ### What's saved in each profile?
25 |
26 | The _General_, _Integrations_, and _UI Preferences_ settings configured under your Preferences are profile-specific.
27 |
28 | [Tabs](/start-here/interface/#tabs) are unique to each profile. When creating a new profile, GitKraken Client will use the same tabs that are open in your current profile.
29 |
30 | 
31 |
32 | Integrations are unique to each profile. If you need to connect to a second remote hosting account, create a second profile and connect the other account from the Integrations tab. You can do this for any of the integrations.
33 |
34 | 
35 |
36 | ### Changing Avatars
37 | Your commit avatar is either a generated identicon, or the active [Gravatar](https://gravatar.com) image linked to your 
42 |
43 | 
44 |
45 | You can choose from the list of icons available on the left then click . Alternatively, you can set a different email address for this profile if the email address has a different Gravatar image associated to it.
46 |
47 | 
48 |
49 | ### Author initials in graph
50 |
51 | GitKraken Client lets you replace all commit nodes with the commit author's initials.
52 |
53 | 
54 |
55 | Navigate to Preferences UI Preferences to enable the setting.
56 |
57 | #### What initials does GitKraken Client use?
58 |
59 | If you are just enabling this UI setting, GitKraken Client will reference the original name associated with the commit.
60 |
61 | If a commit was made in GitKraken Client, the app will list initials from the GitKraken user profile. If a commit was made in the CLI, the app will list initials from the user's `.git/config` or global `.gitconfig`.
62 |
63 |
64 | ### Do profiles allow different identity pictures?
65 |
66 | As long you have different email addresses with the profiles associated with Gravatar images, then yes! GitKraken Client at this time does not allow selection of custom images.
67 |
68 |
--------------------------------------------------------------------------------
/docs/working-with-repositories/open-clone-init.md:
--------------------------------------------------------------------------------
1 | ---
2 |
3 | title: Open, Clone, and Init
4 | description: Learn the basics of GitKraken Client, like initializing or cloning projects!
5 |
6 | ---
7 |
8 | Whether you are a newborn or a wizened deep-ocean octopod, each user will need to open, clone, or initialize a repo in GitKraken Client.
9 |
10 | ***
11 | ## Setup
12 | The essential setup process includes:
13 |
14 | 1. [Installing](/how-to-install) GitKraken Client
15 | 2. Creating an account and setting up your [profile](/start-here/profiles)
16 |
17 | Once this is complete, you are ready for your oceanic journey!
18 |
19 | ***
20 | ## Projects in GitKraken Client
21 | There are three ways to start a Git repository when working on a project:
22 |
23 | 1. **Open** - Open a local Git repository already initialized and available locally.
24 | 2. **Clone** - Clone a remote Git repository already initialized.
25 | 3. **Init** - Create an empty Git repository or reinitialize an existing one.
26 |
27 | ***
28 |
29 | ### Opening an existing project
30 | GitKraken Client allows you to load your existing repositories and pick up where you left off. It's also useful for visualizing past work done.
31 |
32 | If you're coming from a Git project you already have locally, navigate to File Open Repo to get started immediately in GitKraken Client.
33 |
34 | 
35 |
36 | ***
37 | ### Cloning an existing project
38 | If your project is not on your local machine or you want a new copy, clone the project through File Clone.
39 |
40 | 
41 |
42 | This will then prompt you to open the newly copied project in GitKraken Client.
43 |
44 | ***
45 | ### Initialize a new project
46 | Starting a project in GitKraken Client is easy through File Init
47 |
48 | 
49 |
50 | All you need to do is fill out the fields and select for the magic to begin.
51 |
52 | #### Input
53 | * New repository path
54 | * `.gitignore` template (**optional**)
55 | * Automatically creates a `.gitignore` file in your working copy.
56 |
57 | * License (**optional**)
58 | * On init, GitKraken Client will create a `LICENSE` file in your repository.
59 | * Check out the [Open Source Initiative](https://opensource.org/licenses) or find out more about [Choosing a License](http://choosealicense.com/).
60 |
61 | #### Output
62 | * A new initialized Git project at the specified repository path by creating a `.git` folder.
63 | * The project is opened in GitKraken Client
64 | * An "Initial commit" on a `master` branch containing a blank `README.md` along with a `.gitignore` and `LICENSE.md` if applicable.
65 |
66 | 
78 |
79 | Then browse through your repo list and right-click on the repository you wish to delete from your local machine.
80 |
81 | 
82 |
83 | If you are unable to delete the repository, first make sure it is closed in GitKraken Client and then close any other applications which may be working with files in the repository. Restart GitKraken Client and try the delete again.
84 |
85 | Deleting the repo from within GitKraken Client will only delete your local copy of the repository. If you wish to delete your remote repository, you will need to perform that action directly by logging into your remote hosting service (GitHub, GitLab, etc).
86 |
--------------------------------------------------------------------------------
/docs/working-with-repositories/githooksexample.md:
--------------------------------------------------------------------------------
1 | ---
2 |
3 | title: Git hooks example
4 | description: Basic example on how to create a git hook.
5 |
6 | ---
7 |
8 | Git hooks are scripts that perform automated actions when a specific action is performed in GitKraken Client or the command line. The git hook name usually indicates the hook's trigger _(e.g. pre-commit)_.
9 |
10 | Git hooks live under the `.git` folder of your repo in a directory called hooks. The path to the hooks will look similar to `repo/.git/hooks`.
11 |
12 | ***
13 |
14 | ### Tools needed
15 | - GitKraken Client
16 | - Text Editor - I will be using [Visual Studio Code](https://code.visualstudio.com/)
17 | - Terminal - I will be using [iTerm2](https://www.iterm2.com/)
18 |
19 | ### Hook Purpose
20 | In this example, we'll create a `pre-commit` hook. This hook validates the git config's global user email and checks whether a _gpg key_ exists. The hook is useful so that the commits contain the correct committer email address and also to ensure the commits are signed.
21 |
22 | ### Creating the git hook
23 |
24 | #### Step 1
25 | First navigate to the hooks directory for the target repo. Open a Visual Studio Code window and navigate to repo .git hooks. From here, add a new file to the `.git/hooks` directory called `pre-commit`.
26 |
27 | 
28 |
29 | 
41 |
42 | 
--------------------------------------------------------------------------------
/docs/working-with-repositories/githooks.md:
--------------------------------------------------------------------------------
1 | ---
2 |
3 | title: Git hooks
4 | description: Compare your changes with diffs in GitKraken Client. Learn about where to access diffs, file blame, and more.
5 |
6 | ---
7 |
8 | Git hooks are shell scripts that execute after an event such as a commit or push.
9 |
10 | In the following video, we will take you through the basics of what a Git hook is and demonstrate how to use one in GitKraken Client.
11 |
12 | 
26 |
27 | If running OSX or Linux, GitKraken Client will seamlessly detect any Git hooks in your repository if your scripts are set to be executable. If you forgot to set your files to executables, GitKraken Client will throw an error as a heads up.
28 |
29 | And if running Windows, GitKraken Client will detect your Git hooks automatically.
30 |
31 | ***
32 |
33 | ## Define a custom hook path
34 |
35 | Users can define a custom path for git hooks by going to Preferences Git Hooks. to the location or enter the path to your git hook folder.
36 |
37 | This custom git hook path is defined on a per-repository basis.
38 |
39 | 
40 |
41 | ***
42 |
43 | ## What hooks are supported by GitKraken Client?
44 |
45 | Here are the hooks supported by GitKraken Client. Where appropriate, beneath each hook are the actions during which GitKraken Client calls that hook:
46 |
47 | 
101 |
102 | Next navigate to `Environmental Variables...` Double click **Path** Click `New` to add the paths.
103 |
104 | 
105 |
106 | 
107 |
108 | 
109 |
110 | You will likely need to add both git and git LFS (LFS can have multiple paths, you would want to add them all).
111 |
--------------------------------------------------------------------------------
/docs/working-with-commits/staging.md:
--------------------------------------------------------------------------------
1 | ---
2 |
3 | title: Staging
4 | description: Learn how to stage and review your files before making your commit.
5 |
6 | ---
7 |
8 | When you are working on a project, the staging pane is where changes are prepped for commit.
9 |
10 | ***
11 |
12 | 
20 |
21 | Once the //WIP node is selected, a will appear when you hover over a file in the Commit Panel.
22 |
23 | 
24 |
25 | You may also click on a file for review in the diff or click the . To stage specific lines, select the file, highlight the target lines, then right-click to access the Stage selected lines option.
26 |
27 | 
28 |
29 | 
42 |
43 | If you need to unstage all files, use the button just above the Staged Files section. From here you should be set to [commit](/working-with-commits/commits)!
44 |
45 | ***
46 |
47 | 
54 |
55 | To discard changes, select the _//WIP_ node to summon the icon. This option will discard all changes or discard any multi-selected files.
56 |
57 | 
58 |
59 | If more than one changes needs to be discard, multi-select files to **multi-discard**.
60 |
61 | 
62 |
63 | Next, you may discard hunks of changes from the [diff](/working-with-commits/diff) of any file.
64 |
65 | 
66 |
67 | Alternatively in the staging panel, `Discard Changes` is available in the context menu by right-click.
68 |
69 | ***
70 |
71 | 
82 |
83 | From this menu you may choose to ignore:
84 | * The specific file selected
85 | * All files with that same file extension
86 | * All files in that same directory
87 |
88 | GitKraken Client will create the `.gitignore` file (unless one already exists) at the root of your repo directory and add the appropriate entry, based on your ignore selection.
89 |
90 | 
101 |
102 | Selecting `Ignore` will add the corresponding entry to the .gitignore file, but the changes will not be ignored, because the file is already being tracked by git.
103 |
104 | 
105 |
106 | Selecting `Ignore and Stop Tracking` will add the corresponding entry to the `.gitignore` file and remove the file from the git index, so git stops tracking it.
107 |
108 | 
--------------------------------------------------------------------------------
/docs/working-with-commits/diff.md:
--------------------------------------------------------------------------------
1 | ---
2 |
3 | title: Diff, Blame, and History
4 | description: Compare your changes with diffs in GitKraken Client. Learn about where to access diffs, file blame, and more.
5 |
6 | ---
7 |
8 |
9 | Compare changes within GitKraken Client _diffs_. Learn where to access _diffs_, and how to access _file history_ or _file blame_.
10 |
11 | ***
12 |
13 | 
20 |
21 | GitKraken Client's diff comes included with the following:
22 |
23 | - Word diffing
24 | - Syntax highlighting
25 | - File mini-map
26 | - Toggles between Hunk View, Inline View, and Split View
27 | - Arrows to move between change sets
28 |
29 | Most importantly, the button allows you to edit this file directly. Learn more about this feature in [Editing Files](/working-with-files/editing-files) section.
30 |
31 | ***
32 | ## Where can I access the diff?
33 |
34 | Access the diff of a file from:
35 |
36 | * **Staging**: Click on a file
37 | * **Commit node**: With a commit node selected, click on any file
38 |
39 | If you have two commits selected, GitKraken Client shows the difference between the two commits.
40 |
41 | 
42 |
43 | Additionally, select multiple commit rows in the graph using Shift Click to show its merged diff:
44 |
45 | 
46 |
47 | ### Hunk view
48 |
49 | Hunk view will show the diff as blocks, without the context of the rest of the file.
50 |
51 | 
52 |
53 | ### Inline view
54 |
55 | Inline view will show the diff within the context of the entire file.
56 |
57 | 
58 |
59 | ### Split view
60 |
61 | Split view will show a side by side diff comparing how the file looked before (left), and how it looks after the change (right). Note, you may select deleted lines with your mouse from split view.
62 |
63 | 
64 |
65 | ***
66 |
67 | ## External diff tools
68 | Configure your preferred external diff tool from Preferences General:
69 |
70 | 
71 |
72 | GitKraken Client currently _only supports_ the following diff tools:
73 |
74 | - Beyond Compare
75 | - FileMerge
76 | - Kaleidoscope
77 | - KDiff
78 | - Araxis
79 | - P4Merge
80 |
81 | If your diff tool from the list above is installed and is not showing up in the dropdown, then look for an option to install command line tools.
82 |
83 | 
84 |
85 | If you would like to use another diff tool, navigate to Preferences General and set the Diff Tool to _Git Config Default_. Then open your global `.gitconfig` file and add these additional lines to use that diff tool. Here are some examples for each operating system:
86 |
87 | #### Mac OS
88 | ```
89 | [diff]
90 | tool = meld
91 | [difftool "meld"]
92 | cmd = open -a Meld --args \"$LOCAL\" \"$REMOTE\"
93 | ```
94 |
95 | #### Linux
96 | ```
97 | [diff]
98 | tool = meld
99 | [difftool "meld"]
100 | cmd = meld \"$LOCAL\" \"$REMOTE\"
101 | ```
102 |
103 | #### Windows
104 | ```
105 | [diff]
106 | tool = meld
107 | [difftool "meld"]
108 | cmd = \"C:\\Program Files\\Meld\\Meld.exe\" "$LOCAL" "$REMOTE"
109 | ```
110 |
111 | ***
112 | ## Diff multiple commits
113 |
114 | Use the Shift or Cmd/Ctrl key to select multiple commits in the graph.
115 |
116 | 
117 |
118 | This will produced a combined diff, which lists all files that were added, modified, renamed or deleted between the selected commits in the Commit Panel.
119 |
120 | 
132 |
133 | You may also click on a commit in the graph and then right click a file to access _File History_ or _File Blame_. _File History_ shows that file's commit history on the left.
134 |
135 | 
136 |
137 | _File Blame_ will color code the commit author of each line or hunk.
138 |
139 | 
140 |
141 | Use the top toggle button to switch between Diff View, which shows the selected commit's changes to the file, and the File View, which shows the file's state at that commit, including the blame info.
142 |
--------------------------------------------------------------------------------
/docs/working-with-repositories/workspaces.md:
--------------------------------------------------------------------------------
1 | ---
2 |
3 | title: Workspaces
4 | description: Workspaces allow you to create groups of repositories.
5 |
6 | ---
7 |
8 | GitKraken Workspaces allow you to create easily accessible groups of repositories, take action across multiple repos, view details about their state at a glance, and share them with your team.
9 |
10 | 
26 |
27 | ## Team Workspaces
28 |
29 | Workspaces are available as either a *Personal* or *Team* type.
30 |
31 | **Personal Workspaces** are only accessible by you on this machine.
32 |
33 | **Team Workspaces** will be available for the selected teams within your organization. This helps ensure that everyone is up-to-date on the same set of repositories by offering 
36 |
37 | Learn more about [how to create a team](https://support.gitkraken.com/start-here/teams/).
38 |
39 | ## Edit a workspace
40 |
41 | Edit a workspace by selecting the ellipsis icon by the Workspace name.
42 |
43 | 
44 |
45 | ## Multi-repository actions
46 |
47 | All repositories in a Workspace can be cloned, fetched, or opened at once, making it easy to get a new member of your team onboarded quickly or keep repository information up-to-date. Repositories can be effortlessly opened in GitKraken, in your 
52 |
53 | ## Repository statuses
54 |
55 | Workspaces expose the state of all repositories so you can see the last checked-out branch, how many commits are ahead or behind the remote, and your work in progress with counts of modified added, deleted, and renamed files.
56 |
57 | 
58 |
59 |
60 | ## Workspace breadcrumb in toolbar
61 |
62 | The option to remove the Workspace breadcrumb in the toolbar can be toggled under Preferences > UI Customization > _Show Workspace breadcrumb in toolbar_.
63 |
64 | 
65 |
66 | ## View Repository Details
67 |
68 | You may select the list icon to open the repository details.
69 |
70 | 
71 |
72 | ## Pull requests
73 |
74 | The Pull Request section will show all open pull requests for all repositories within the selected workspace. Information shown here includes the pull request title, pull request number, CI status, the name of the branch being merged, and number of comments.
75 |
76 | To view a workspaces pull requests, select a workspace and then select `Pull Requests`.
77 |
78 | 
79 |
80 | Select `Filter pull requests` to filter for pull requests with the following options:
81 |
82 | * "Opened by Me", to show pull requests that were opened by the user. This filter is available for GitHub, GitHub Enterprise, GitLab, and GitLab Self-Managed repositories.
83 | * "At Risk", to show any pull requests that are not drafts and have been open for longer than 7 days. This filter is currently only available for GitHub, GitHub Enterprise, GitLab, and GitLab Self-Managed repositories.
84 | * "By repository", to limit the view to a single repo within the Workspace. This filter is currently available for Azure DevOps, GitHub, GitHub Enterprise, Gitlab, and Gitlab Self-Managed repositories.
85 |
86 | The search allows searching by pull request titles for all services. For GitHub.com workspaces, 
89 |
90 | At risk pull requests are pull requests that have not been updated in more than 7 days and are not in draft. This is shown for GitHub, GitHub Enterprise, GitLab and GitLab Self-Managed pull requests. This is indicated by the `At risk` label.
91 |
92 | 
93 |
94 | ### GitHub pull request view
95 |
96 | If you are working with a GitHub.com workspace, you may select a pull request to work with the 
--------------------------------------------------------------------------------
/docs/start-here/tips.md:
--------------------------------------------------------------------------------
1 | ---
2 |
3 | title: Tips
4 | description: Find out all the things users should know to boost their GitKraken Client experience.
5 |
6 | ---
7 |
8 | Here's the TLDR of the best features in GitKraken Client.
9 |
10 | ***
11 |
12 | ### 1. Set up Profiles
13 |
14 | If you have personal projects you wish to separate from work repos–or if you need to connect to multiple instances of GitHub, GitLab, Bitbucket, etc.–then set up [Profiles](/start-here/profiles).
15 |
16 | 
31 |
32 | As you type, the Command Palette will find the most relevant commands, allowing you to perform many actions without clicking. Here are a few examples:
33 |
34 | 
84 |
85 | You can also right click the empty space in the Commit Panel and click the `Create File` context menu option.
86 |
87 | To open an existing file to the built-in code editor, select a branch and navigate to the file you'd like to edit in the Commit Panel.
88 |
89 | Double click the file to bring it to File View. From File View, you can click to edit a file and make changes directly. You'll notice syntax highlighting, code hinting, a file minimap, and the ability to search your file.
90 |
91 | 
92 |
93 | Learn more about [editing files](/working-with-files/editing-files) in GitKraken Client.
94 |
95 | To delete a file, right-click on the file from the Commit Panel to access the delete option.
96 |
97 |
98 | ***
99 |
100 | ### 5. Favorite Repos
101 |
102 | Favorite the repos you work on most so they show up at the top of your list.
103 |
104 | 
117 |
118 | ### Benefits
119 |
120 | - Create repositories on GitHub/GitLab/Bitbucket/Azure DevOps including .gitignore and license
121 | - Save authentication into profiles
122 | - Clone from remote repo list
123 | - Add remotes
124 | - Create and view pull requests
125 |
126 | ***
127 |
128 | ### 7. Build Status, Assignees, and Reviewers in PRs
129 |
130 | If you are using the GitLab or GitHub integration, you may also add a pull request assignee and label(s) to your pull request. GitKraken Client will then pass these values onto GitLab or GitHub when the pull request is created.
131 |
132 | 
133 |
134 | If you are using the GitHub integration, you may also add reviewers and multiple assignees to a pull request.
135 |
136 | 
137 |
138 | Additionally for GitHub pull requests, this tooltip will show assignees, labels, reviewers, and build status.
139 |
140 | 
141 |
142 | Learn more about [pull requests](/working-with-repositories/pull-requests).
143 |
144 | ***
145 |
146 | ### 8. File History and File Blame
147 |
148 | File History and File Blame information display in the same view.
149 |
150 | To access either option, first click on a commit in the graph. Then right click a file to access File History or File Blame.
151 |
152 | 
157 |
158 | Use the top toggle button to switch between Diff View, which shows the selected commit's changes to the file, and the File View, which shows the file's state at that commit, including the blame info.
159 |
160 | ***
161 |
162 | ### 9. Open Terminal
163 |
164 | You can open the terminal or CLI from GitKraken Client!
165 |
166 | To open the current repo folder in terminal, go to File Open Terminal or use the keyboard shortcuts opt + T (Mac) / alt + T (Windows + Linux).
167 |
168 | You can set your default terminal from Preferences General.
169 |
170 | ***
171 |
172 | ### 10. Resize the Graph
173 |
174 | It's simple, but easy to miss. Hover over any of the colored lines to drag and drop the graph.
175 |
176 | 
177 |
178 |
179 | Resize and marvel at the colors of the rainbow.
180 |
181 |
182 |
183 |
--------------------------------------------------------------------------------
/docs/start-here/preferences.md:
--------------------------------------------------------------------------------
1 | ---
2 |
3 | title: Preferences
4 | description: Customize your GitKraken Client experience to match your tastes!
5 |
6 | ---
7 |
8 | Navigate to Preferences to customize your GitKraken Client experience. Here are what each of the major sections do.
9 |
10 |
11 | 
12 |
13 | ***
14 |
15 | ## Organization
16 |
17 | This section will actually be labeled with your organization name rather than "Organization". It shows the members and teams within your organization. Click `switch organization` to swap to another organization.
18 |
19 | The Owner and any Admins are able to:
20 |
21 | - Change role of members within the organization
22 | - Invite members to the organization and purchase licenses
23 | - Create and manage teams
24 |
25 |
26 | 
26 |
27 | The graph updates with your commit, but the undo button or this keyboard shortcut
28 | ⌘ + Z for Mac or Ctrl + Z for Windows/Linux can undo a commit made by mistake.
29 |
30 | 
43 |
44 | The commit panel will then show the co-author in the history for that commit:
45 |
46 | 
47 |
48 | ***
49 |
50 | 
71 |
72 | There are three different ways to set up commit templates in GitKraken Client:
73 |
74 | * **Create the template in GitKraken Client** - This will create a file called `gkcommittemplate.txt` in your repository's `.git/` directory.
75 |
76 | * **Add a repo-specific commit template** - Open a terminal in your local repository and run `git config commit.template 
95 |
96 | If you only need to update the commit message, select the most recent commit and click in the message box to amend the message.
97 |
98 | 
99 |
100 | To accommodate viewing a longer commit description, click on the bar at the the bottom of the message box and drag downwards to dynamically resize the text field.
101 |
102 | 
103 |
104 |
105 | Select to save your changes or to discard.
106 |
107 | 
123 |
124 | You may also drag and drop a branch onto another to select from the three reset options above or access the reset options from your local repos in the left panel.
125 |
126 | ***
127 |
128 | 
132 |
133 | Undo, undo, undo. You can undo many of your actions in GitKraken Client with the Undo icon.
134 |
135 | If you're a keyboard fan, you may also enjoy using the keyboard shortcut
136 | ⌘ + z for Mac or Ctrl + Z for not-Mac.
137 |
138 | 
145 |
--------------------------------------------------------------------------------
/docs/working-with-repositories/branching-and-merging.md:
--------------------------------------------------------------------------------
1 | ---
2 |
3 | title: Branching and Merging
4 | description: Learn about branching and merging in GitKraken Client.
5 |
6 | ---
7 |
8 | Learn how to branch and merge in GitKraken Client. 🌳 🔀
9 |
10 | ***
11 |
12 | ## Branches
13 | When starting work on a new feature or bug, 
16 |
17 | A branch is a pointer to a specific commit in the repo, rather than making entire copies of the working directory files.
18 |
19 | Branches allow you to isolate new work from other areas of the repository, and consider implementing [GitFlow](/git-workflows-and-extensions/git-flow) as a merging strategy.
20 |
21 | ### Checking out branches
22 | Branch checkout updates files in the working directory to reflect the version defined by that branch.
23 |
24 | New commits are added to the checked out branch. If you find yourself on the wrong branch, [stash](/working-with-commits/stashing) your changes, switch to the correct branch, and then *pop* the stash.
25 |
26 | When you create a new branch, GitKraken Client will automatically checkout the branch for you:
27 |
28 | 
30 | 
42 |
43 | 
57 |
58 | 
77 |
78 | Clicking a conflicted file opens the _Merge Tool_.
79 |
80 | The current branch is on the left, and the target branch that you're merging into is shown on the right. The _Merge Tool_ output is at the bottom.
81 |
82 | 
83 |
84 | Each conflict section has a checkbox. Checking a section adds it to the **Output** at the bottom so you can see the options in context to decide which makes the most sense to commit.
85 |
86 | 
87 |
88 | You can also mouse over the line number and click to select specific lines for the Output, or edit the Output window directly.
89 |
90 | Clicking the up and down arrows will move you to the next conflict.
91 |
92 | 
102 | 
115 |
116 | GitKraken Client currently supports the following merge tools:
117 |
118 | * Beyond Compare
119 | * FileMerge
120 | * Kaleidoscope
121 | * KDiff
122 | * Araxis
123 | * P4Merge
124 |
125 | If your merge tool from the list above is installed and is not showing up in the dropdown, then look for an option to install command line tools.
126 |
127 | 
146 |
147 | ***
148 |
149 | ## Rebasing
150 | Rebasing takes the commits from one branch and places them onto the last commit of another branch. This alters the tree structure by moving the commits and their changes onto the target branch.
151 |
152 | 
159 |
160 | You can rebase onto a local or remote.
161 |
162 | 
163 |
--------------------------------------------------------------------------------
/docs/git-workflows-and-extensions/commit-signing-with-gpg.md:
--------------------------------------------------------------------------------
1 | ---
2 |
3 | title: Commit Signing with gpg
4 | description: Learn how to create GPG keys and sign your commits in GitKraken Client
5 |
6 | ---
7 |
8 | ##What is Commit Signing?
9 |
10 | In Git, you may commit using any name and email address. However, Git supports signing commits and annotated tags using a GPG key pair.
11 |
12 | By signing a commit, other users with your public key can verify the commit was created by the owner of that key. Users can also share their public key with their remote hosting service, such as GitHub, so that commits appear as verified on their website.
13 |
14 | ###Commit Signing Requirements
15 |
16 | Before you start signing your commits, you will first need to install and configure GPG. GPG download files can be found [here](https://www.gnupg.org/download/index.html). Our recommendations to get GPG installed quickly are below.
17 |
18 | 
40 |
41 |
42 | ###Generating a GPG Key In GitKraken
43 |
44 | If you have GPG installed on your local machine, you will be able to generate a GPG key pair from within GitKraken Client.
45 | 
52 |
53 | ###Configure GPG in GitKraken
54 |
55 | Once you have GPG installed on your machine, you will need to configure GitKraken to use GPG. Launch GitKraken Client and navigate to Preferences → GPG Preferences.
56 |
57 | 
58 |
59 | + **Signing Key:** This dropdown list will contain all of your local keys. Select the key you wish GitKraken Client to use when signing your commits and annotated tags. **If this list is blank you can try the following troubleshoots:**
60 | * You may need to configure the GPG Program setting first.
61 | + If you installed GPG while GitKraken Client was open, you may need to fully close GitKraken Client and re-launch it.
62 |
63 | + **GPG Program:** This is the location of where GPG is installed on your local machine. If GPG is on your path, GitKraken Client should automatically detect the GPG program. However, it is possible to have multiple installations of GPG so you can specify which one GitKraken Client should point to by using the
64 |
65 | button.
66 |
67 | 
68 |
69 | If you do not know where GPG is installed on your local machine, launch a terminal and enter: `which gpg` for Mac & Linux. On Windows, use: `where gpg`
70 |
71 | + **Sign Commits by Default:** Enabling this checkbox will have GitKraken Client sign any commit you create going forward.
72 |
73 | + **Sign Tags by Default:** Enabling this checkbox will have GitKraken Client sign any annotated tags you create going forward.
74 |
75 | + **Generate new GPG Key:** GitKraken Client will generate a new GPG key for you, see [Generating a GPG Key In GitKraken](/git-workflows-and-extensions/commit-signing-with-gpg/#generating-a-gpg-key-in-gitkraken).
76 |
77 | ###Verifying a Local Commit is Signed
78 |
79 | You can verify a commit has been signed by selecting a commit and viewing the commit panel. An icon will appear to the left of the commit SHA on signed commits only.
80 |
81 | 
82 |
83 | If you hover over the badge, you will see a tooltip which displays the Signature details.
84 |
85 | 
86 |
87 | Below is a list of possible signature codes and what they mean:
88 |
89 | + `GOODSIG` -- The signature with the keyid is good.
90 | + `EXPSIG` -- The signature with the keyid is good, but the signature is expired.
91 | + `EXPKEYSIG` -- The signature with the keyid is good, but the signature was made by an expired key.
92 | + `REVKEYSIG` -- The signature with the keyid is good, but the signature was made by a revoked key.
93 | + `BADSIG` -- The signature with the keyid has not been verified.
94 | + `ERRSIG` -- It was not possible to check the signature. This may be caused by a missing public key or an unsupported algorithm.
95 |
96 |
97 | ###Uploading Your GPG Key to a Remote Hosting Service
98 |
99 | To upload your GPG public key to your remote hosting service, we recommend viewing the documentation for the respective hosting service:
100 |
101 | * [GitHub](https://help.github.com/articles/adding-a-new-gpg-key-to-your-github-account/)
102 | * [GitLab](https://docs.gitlab.com/ee/user/project/repository/gpg_signed_commits/#adding-a-gpg-key-to-your-account)
103 | * [Bitbucket](https://confluence.atlassian.com/bitbucketserver/using-gpg-keys-913477014.html#UsingGPGkeys-AddaGPGkeytoBitbucketServer)
104 |
105 | To copy your GPG public key in GitKraken Client, navigate to Preferences → GPG Preferences and below your Signing Key, select `Copy GPG Public Key`.
106 |
107 | ###Editing Your GPG Key
108 |
109 | Editing your gpg key is helpful when you wish to add another email address to a key or renew an expired key. To edit a GPG key, navigate to your terminal and enter `gpg --list-secret-keys --keyid-format LONG`. This command will output a list of your GPG keys, take note of the ID of the key you wish to edit.
110 |
111 | 
112 |
113 | Now that you have the key ID, you can edit the key. To do so enter `gpg --edit-key FFFFFF` where `FFFFFF` is your key ID. You will then enter an editing session with your GPG key. After you update your key, execute a `save` to record changes and quit editing the key.
114 |
115 | Below is a list of useful commands to edit your key:
116 |
117 | + `adduid`- Add a new user ID to the GPG key
118 | + `deluid` - Delete a user ID from the GPG key
119 | + `trust` - Change the owner trust value. This updates the trust database immediately and no save is required.
120 | + `expire` - Change a key expiration time
121 | + `save` - Save all changes to the current key and quit
122 | + `quit` - Quit without updating the current key
123 |
124 | For a complete list you can review [GNU’s documentation](https://www.gnupg.org/gph/en/manual/r899.html).
125 |
126 | Make sure to upload the updated key on your hosting service once you have saved. See [Uploading Your GPG Key to a Remote Hosting Service](/git-workflows-and-extensions/commit-signing-with-gpg/#uploading-your-gpg-key-to-a-remote-hosting-service).
127 |
128 | ###Deleting your GPG Key
129 |
130 | You can delete your key via terminal with the command `gpg --delete-secret-keys` simply append your username or key ID.
131 | 
132 |
133 | There will be several prompts to make sure that you *really* want to delete your GPG key:
134 | 
135 |
136 |
--------------------------------------------------------------------------------
/docs/start-here/guide.md:
--------------------------------------------------------------------------------
1 | ---
2 |
3 | title: New to Git
4 | description: Learn how to get started with GitKraken Client.
5 |
6 | ---
7 |
8 | Whether you are a newborn or a wizened deep-ocean octopod, this Getting Started Guide uses a basic workflow to provide an overview of GitKraken Client interface from cloning your repository to successfully executing Git actions.
9 |
10 | ***
11 |
12 | ## Learning Git with GitKraken
13 |
14 | In this series, we'll provide Git tutorial videos. You'll learn Git concepts and how to apply them in GitKraken Client.
15 |
16 | 
68 |
69 | On our newly created repo, we'll branch off from `master` to silo our normal development. To do this, right-click master on the graph and select Create branch here. Let's call this branch `develop` in "_enter branch name_" which is going to be an indefinite main track branch to the project.
70 |
71 | Once created, GitKraken Client will auto checkout `develop` and switch to that new branch.
72 |
73 | ### Changing file content
74 | Now that `develop` is set, we can make some new changes without affecting anything on production.
75 |
76 | In the example, the `README.md` file was created automatically to provide context about the project. This involves creating the file, writing content, and then saving it to disk. With Git, the last step to save becomes more granular in order to write desired changes for revision history.
77 |
78 |
79 | `README.md` was created as a placeholder and the project can become more meaningful by modifying the file with the project context, as well as adding additional project files. Any modifications and additions will have to be staged and committed, which will only affect our current branch.
80 |
81 |
82 | You can select _Initial Commit_ from the graph, and click `README.md` to open the built-in editor.
83 |
84 | 
85 |
86 | ### Staging and Committing
87 | Say you made changes to the `README.md` file. When selecting the _//WIP_ node, there will now be pending changes to `README.md` in the staging panel under _Unstaged Files_.
88 |
89 | 
90 |
91 | Next, let's move these changes into the _Staged Files_ section by selecting the green button.
92 |
93 | Outside of Git, work is done in a typical File Save method or written automatically when changes are detected. In a way, committing in Git is like the Save, where we've made a pointer to the changes in this current version of the file to keep in history.
94 |
95 | From here, type a brief summary of your changes and click to save your changes to the `README.md` file. This effectively updates the reference on `develop`, pointing to your first modification after _Initial Commit_.
96 |
97 | 
109 |
110 | In order to add this commit into the original branch, we will merge `develop` back into `master`. This will take all of the changes introduced since the last commit and play them on this branch by performing a new commit (called a merge commit) with the changes.
111 |
112 | There are a few ways to perform the merge action in GitKraken Client, but perhaps the easiest is from within the graph.
113 |
114 | In the graph, you can see we have things in a new branch, `develop`, that we want in our source branch, `master`. Like any sensible person, we would only have to pick up `develop` and throw it at `master` right? Right! Simply drag `develop` and drop it on `master` to get the merge option.
115 |
116 | 
117 |
118 | Alternatively the same merge can be performed through right click and other means. Revisit and learn more about merging and other options available through [Branching and Merging](/working-with-repositories/branching-and-merging).
119 |
120 | ### Summary
121 |
122 | In the end, this is as simple as it gets in terms of workflow and paves the way for incorporating changes into [pushing and pulling](/working-with-repositories/pushing-and-pulling) or venturing to advanced models like [GitFlow](/git-workflows-and-extensions/git-flow).
123 |
124 | Remember, you must crawl before you can walk and without a doubt you will be running in no time!
125 |
126 | Below is a sample video on how a simple commit is created as was explained in this guide. For more topics `checkout` the rest of the categories and pages listed.
127 |
128 | Your quest continues!
129 |
130 |
131 | 
40 | Pushing takes any local changes , and making them available on the remote .
41 |
42 | Push the currently checked out branch by clicking Push 
45 |
46 | Pushing attempts to upload any new commits to the remote branch, then fast-forward the remote to bring it up to date with the local repo.
47 |
48 | If the remote branch cannot be fast-forwarded, the push will be refused. If this is the case, GitKraken Client will provide the option to _Pull (fast-forward if possible)_, or .
49 |
50 | 
61 |
62 | ***
63 | ## Fetching
64 | Pulling and fetching take updates from the remote and get them into our local repo.
65 |
66 | 
67 |
68 | ### Fetch All
69 | Fetching gets updates from remote branches, but does not update any files in your working directory.
70 |
71 | Updates will appear in the graph, and also update any branches on the left to show how many commits you are ahead or behind.
72 |
73 | When you're behind the remote, it means that there are commits on the remote branch which have not been incorporated into the local repo. _Pull (fast-forward if possible)_ to get these changes on local.
74 |
75 | 
76 |
77 | If you are ahead of the remote branch, there are local commits that have not yet been pushed to the remote.
78 |
79 | It is possible to be both ahead of and behind a remote. However if you are both ahead and behind a remote, you will not be able to perform a _Pull (fast-forward if possible)_ as the branches have diverged. Consider rebasing onto the remote first.
80 |
81 | GitKraken Client automatically fetches updates from your remote repositories every minute by default. You can change this setting from Preferences General menu.
82 |
83 | ### Fast-forwarding
84 | Fast forwarding moves the currently checked out commit to one that was added later, replaying all commits in between in the order which they happened.
85 |
86 | 
91 |
92 | ***
93 | ## Pulling 
94 | Pulling first performs a fetch and then incorporates any commits in the remote repository into the local copy.
95 |
96 | There are three pulling options. Let's demonstrate what each one does by starting with an example 2 commits made locally, and 2 that have been made on the remote.
97 | 
99 | 
109 | 
122 | 
133 |
134 | Our [interface](/start-here/interface) page covers this and more.
135 |
136 |
137 | ***
138 | ## Setting the upstream branch
139 | Whenever pushing, pulling, or fetching, GitKraken Client gets updates from the _Upstream_ branch.
140 |
141 | The _Upstream_ defaults to the remote branch where the local branch was checked out, but you may change the _Upstream_ to push, pull, or fetch from a different branch.
142 |
143 | Right click on a branch to 
146 |
147 | Alternatively, drag and drop a branch to push instead of setting upstream.
148 |
149 | 
--------------------------------------------------------------------------------
/docs/start-here/keyboard-shortcuts.md:
--------------------------------------------------------------------------------
1 | ---
2 |
3 | title: Keyboard Shortcuts
4 | description: At anytime in GitKraken Client, you can pull up a full list of keyboard shortcuts available. Work faster in GitKraken Client with keyboard shortcuts. Learn more.
5 |
6 | ---
7 |
8 | We know keyboard shortcuts help get things done faster, and here’s a handy list of the shortcuts currently supported by GitKraken Client.
9 |
10 | ***
11 | ### Open list of keyboard shortcuts
12 |
13 |