--- name: "got" section: "1" platform: "linux" package: "got" version: "0.111-1" release: "Debian 13 (Trixie)" platforms: ["linux"] url: "https://new.carta.tech/got" --- # got(1) Game of Trees ## NAME **got** – Game of Trees ## SYNOPSIS **got** \[**-hV**\] *command* \[*arg* *...*\] ## DESCRIPTION **got** is a version control system which stores the history of tracked files in a Git repository, as used by the Git version control system. This repository format is described in [git-repository(5)](/git-repository/5.md). **got** is a “distributed” version control system because every copy of a repository is writeable. Modifications made to files can be synchronized between repositories at any time. Files managed by **got** must be checked out from the repository for modification. Checked out files are stored in a *work* *tree* which can be placed at an arbitrary directory in the filesystem hierarchy. The on-disk format of this work tree is described in [got-worktree(5)](/got-worktree/5.md). The **got** utility provides global and command-specific options. Global options must precede the command name, and are as follows: - **-h** Display usage information and exit immediately. - **-V**, **--version** Display program version and exit immediately. The **got** utility only provides commands needed to perform version control tasks. Commands needed for repository maintenance tasks are provided by [gotadmin(1)](/gotadmin/1.md). Git repository server functionality is provided by [gotd(8)](/gotd/8.md). A repository interface for web browsers is provided by gotwebd(8). An interactive repository interface for the terminal is provided by [tog(1)](/tog/1.md). The commands for **got** are as follows: - **init** \[**-A** *hashing-algorithm*\] \[**-b** *branch*\] *repository-path* Create a new empty repository at the specified *repository-path*. After **got** **init**, the new repository must be populated before **got** **checkout** can be used. The **got** **import** command can be used to populate the new repository with data from a local directory. Alternatively, on a server running [gotd(8)](/gotd/8.md), the new repository can be made available to [got(1)](/got/1.md) or [git(1)](/git/1.md) clients by adding the repository to [gotd.conf(5)](/gotd.conf/5.md) and restarting [gotd(8)](/gotd/8.md). Clients may then clone the new repository from the server, populate the cloned repository, and then populate the new repository on the server via **got** **send** or **git** **push**. The options for **got** **init** are as follows: - **-A** *hashing-algorithm* Configure the repository's *hashing-algorithm* used for the computation of Git object IDs. Possible values are **sha1** (the default) or **sha256**. - **-b** *branch* Make the repository's HEAD reference point to the specified *branch* instead of the default branch “main”. The **got** **init** command is equivalent to **gotadmin** **init**. - **import** \[**-b** *branch*\] \[**-I** *pattern*\] \[**-m** *message*\] \[**-r** *repository-path*\] *directory* ``` (alias: im) ``` Create an initial commit in a repository from the file hierarchy within the specified *directory*. The created commit will not have any parent commits, i.e. it will be a root commit. Also create a new reference which provides a branch name for the newly created commit. Show the path of each imported file to indicate progress. The **got** **import** command requires the GOT\_AUTHOR environment variable to be set, unless an author has been configured in [got.conf(5)](/got.conf/5.md) or Git's user.name and user.email configuration settings can be obtained from the repository's *.git/config* file or from Git's global *~/.gitconfig* configuration file. The options for **got** **import** are as follows: - **-b** *branch* Create the specified *branch*. If this option is not specified, a branch corresponding to the repository's HEAD reference will be used. Use of this option is required if the branch resolved via the repository's HEAD reference already exists. - **-I** *pattern* Ignore files or directories with a name which matches the specified *pattern*. This option may be specified multiple times to build a list of ignore patterns. The *pattern* follows the globbing rules documented in [glob(7)](/glob/7.md). Ignore patterns which end with a slash, “/”, will only match directories. - **-m** *message* Use the specified log message when creating the new commit. Without the **-m** option, **got** **import** opens a temporary file in an editor where a log message can be written. Quitting the editor without saving the file will abort the import operation. - **-r** *repository-path* Use the repository at the specified path. If not specified, assume the repository is located at or above the current working directory. - **clone** \[**-almqv**\] \[**-b** *branch*\] \[**-i** *identity-file*\] \[**-J** *jumphost*\] \[**-R** *reference*\] *repository-URL* \[*directory*\] ``` (alias: cl) ``` Clone a Git repository at the specified *repository-URL* into the specified *directory*. If no *directory* is specified, the directory name will be derived from the name of the cloned repository. **got** **clone** will refuse to run if the *directory* already exists. The *repository-URL* specifies a protocol scheme, a server hostname, an optional port number separated from the hostname by a colon, and a path to the repository on the server: **scheme://hostname:port/path/to/repository** The following protocol schemes are supported: - git The Git protocol as implemented by the [git-daemon(1)](/git-daemon/1.md) server. Use of this protocol is discouraged since it supports neither authentication nor encryption. - ssh The Git protocol wrapped in an authenticated and encrypted [ssh(1)](/ssh/1.md) tunnel. With this protocol the hostname may contain an embedded username for [ssh(1)](/ssh/1.md) to use: *user@hostname* - http The “smart” Git HTTP protocol. Not compatible with servers using the “dumb” Git HTTP protocol. The “smart” Git HTTP protocol is supported by **got** **clone** and **got** **fetch**, but not by **got** **send**. Sending from a repository cloned over HTTP will require use of a **send** block in [got.conf(5)](/got.conf/5.md) to ensure that the “ssh://” protocol will be used by **got** **send**. Use of this protocol is discouraged since it supports neither authentication nor encryption. - https The “smart” Git HTTP protocol wrapped in SSL/TLS. Objects in the cloned repository are stored in a pack file which is downloaded from the server. This pack file will then be indexed to facilitate access to the objects stored within. If any objects in the pack file are stored in deltified form, all deltas will be fully resolved in order to compute the ID of such objects. This can take some time. More details about the pack file format are documented in [git-repository(5)](/git-repository/5.md). **got** **clone** creates a remote repository entry in the [got.conf(5)](/got.conf/5.md) and *config* files of the cloned repository to store the *repository-url* and any *branch* or *reference* arguments for future use by **got** **fetch** or [git-fetch(1)](/git-fetch/1.md). The options for **got** **clone** are as follows: - **-a** Fetch all branches from the remote repository's “refs/heads/” reference namespace and set **fetch\_all\_branches** in the cloned repository's [got.conf(5)](/got.conf/5.md) file for future use by **got** **fetch**. If this option is not specified, a branch resolved via the remote repository's HEAD reference will be fetched. Cannot be used together with the **-b** option. - **-b** *branch* Fetch the specified *branch* from the remote repository's “refs/heads/” reference namespace. This option may be specified multiple times to build a list of branches to fetch. If the branch corresponding to the remote repository's HEAD reference is not in this list, the cloned repository's HEAD reference will be set to the first branch which was fetched. If this option is not specified, a branch resolved via the remote repository's HEAD reference will be fetched. Cannot be used together with the **-a** option. - **-i** *identity-file* Specify an *identity-file*, containing a private SSH key, to use with SSH connections. The same option will be passed to [ssh(1)](/ssh/1.md). - **-J** *jumphost* Specify a *jumphost* to use with SSH connections. The same option will be passed to [ssh(1)](/ssh/1.md). - **-l** List branches and tags available for fetching from the remote repository and exit immediately. Cannot be used together with any of the other options except **-q** and **-v**. - **-m** Create the cloned repository as a mirror of the original repository. This is useful if the cloned repository will not be used to store locally created commits. The repository's [got.conf(5)](/got.conf/5.md) and *config* files will be set up with the “mirror” option enabled, such that **got** **fetch** or [git-fetch(1)](/git-fetch/1.md) will write incoming changes directly to branches in the “refs/heads/” reference namespace, rather than to branches in the “refs/remotes/” namespace. This avoids the usual requirement of having to run **got** **rebase** or **got** **merge** after **got** **fetch** in order to make incoming changes appear on branches in the “refs/heads/” namespace. But maintaining custom changes in the cloned repository becomes difficult since such changes will be at risk of being discarded whenever incoming changes are fetched. - **-q** Suppress progress reporting output. The same option will be passed to [ssh(1)](/ssh/1.md) if applicable. - **-R** *reference* In addition to the branches and tags that will be fetched, fetch an arbitrary *reference* from the remote repository's “refs/” namespace. This option may be specified multiple times to build a list of additional references to fetch. The specified *reference* may either be a path to a specific reference, or a reference namespace which will cause all references in this namespace to be fetched. Each reference will be mapped into the cloned repository's “refs/remotes/” namespace, unless the **-m** option is used to mirror references directly into the cloned repository's “refs/” namespace. **got** **clone** will refuse to fetch references from the remote repository's “refs/remotes/” or “refs/got/” namespace. - **-v** Verbose mode. Causes **got** **clone** to print debugging messages to standard error output. This option will be passed to [ssh(1)](/ssh/1.md) if applicable. Multiple -v options increase the verbosity. The maximum is 3. - **fetch** \[**-adlqtvX**\] \[**-b** *branch*\] \[**-i** *identity-file*\] \[**-J** *jumphost*\] \[**-R** *reference*\] \[**-r** *repository-path*\] \[*remote-repository*\] ``` (alias: fe) ``` Fetch new changes from a remote repository. If no *remote-repository* is specified, “origin” will be used. The remote repository's URL is obtained from the corresponding entry in [got.conf(5)](/got.conf/5.md) or Git's *config* file of the local repository, as created by **got** **clone**. By default, any branches configured in [got.conf(5)](/got.conf/5.md) for the *remote-repository* will be fetched. If **got** **fetch** is invoked in a work tree then this work tree's current branch will be fetched, too, provided it is present on the server. If no branches to fetch can be found in [got.conf(5)](/got.conf/5.md) or via a work tree, or said branches are not found on the server, a branch resolved via the remote repository's HEAD reference will be fetched. Likewise, if a HEAD reference for the *remote-repository* exists but its target no longer matches the remote HEAD, then the new target branch will be fetched. This default behaviour can be overridden with the **-a** and **-b** options. New changes will be stored in a separate pack file downloaded from the server. Over time, small pack files will accumulate as a result of repeatedly running **got** **fetch**. For best performance, multiple small pack files can be combined into a single larger pack file with **gotadmin** **cleanup**. The number of pack files in the repository is displayed by **gotadmin** **info**. By default, branch references in the “refs/remotes/” reference namespace will be updated to point at the newly fetched commits. The **got** **rebase** or **got** **merge** command can then be used to make new changes visible on branches in the “refs/heads/” namespace, merging incoming changes with the changes on those branches as necessary. If the repository was created as a mirror with **got** **clone** **-m**, then all branches in the “refs/heads/” namespace will be updated directly to match the corresponding branches in the remote repository. If those branches contained local commits, these commits will no longer be reachable via a reference and will therefore be at risk of being discarded by Git's garbage collector or **gotadmin** **cleanup**. Maintaining custom changes in a mirror repository is therefore discouraged. In any case, references in the “refs/tags/” namespace will always be fetched and mapped directly to local references in the same namespace. The options for **got** **fetch** are as follows: - **-a** Fetch all branches from the remote repository's “refs/heads/” reference namespace. This option can be enabled by default for specific repositories in [got.conf(5)](/got.conf/5.md). Cannot be used together with the **-b** option. - **-b** *branch* Fetch the specified *branch* from the remote repository's “refs/heads/” reference namespace. This option may be specified multiple times to build a list of branches to fetch. Cannot be used together with the **-a** option. - **-d** Delete branches and tags from the local repository which are no longer present in the remote repository. Only references are deleted. Any commit, tree, tag, and blob objects belonging to deleted branches or tags remain in the repository and may be removed separately with Git's garbage collector or **gotadmin** **cleanup**. - **-i** *identity-file* Specify an *identity-file*, containing a private SSH key, to use with SSH connections. The same option will be passed to [ssh(1)](/ssh/1.md). - **-J** *jumphost* Specify a *jumphost* to use with SSH connections. The same option will be passed to [ssh(1)](/ssh/1.md). - **-l** List branches and tags available for fetching from the remote repository and exit immediately. Cannot be used together with any of the other options except **-v**, **-q**, and **-r**. - **-q** Suppress progress reporting output. The same option will be passed to [ssh(1)](/ssh/1.md) if applicable. - **-R** *reference* In addition to the branches and tags that will be fetched, fetch an arbitrary *reference* from the remote repository's “refs/” namespace. This option may be specified multiple times to build a list of additional references to fetch. The specified *reference* may either be a path to a specific reference, or a reference namespace which will cause all references in this namespace to be fetched. Each reference will be mapped into the local repository's “refs/remotes/” namespace, unless the local repository was created as a mirror with **got** **clone** **-m** in which case references will be mapped directly into the local repository's “refs/” namespace. Once a reference has been fetched, a branch based on it can be created with **got** **branch** if needed. **got** **fetch** will refuse to fetch references from the remote repository's “refs/remotes/” or “refs/got/” namespace. - **-r** *repository-path* Use the repository at the specified path. If not specified, assume the repository is located at or above the current working directory. If this directory is a **got** work tree, use the repository path associated with this work tree. - **-t** Allow existing references in the “refs/tags” namespace to be updated if they have changed on the server. If not specified, only new tag references will be created. - **-v** Verbose mode. Causes **got** **fetch** to print debugging messages to standard error output. The same option will be passed to [ssh(1)](/ssh/1.md) if applicable. Multiple -v options increase the verbosity. The maximum is 3. - **-X** Delete all references which correspond to a particular *remote-repository* instead of fetching new changes. This can be useful when a remote repository is being removed from [got.conf(5)](/got.conf/5.md). With **-X**, the *remote-repository* argument is mandatory and no other options except **-r**, **-v**, and **-q** are allowed. Only references are deleted. Any commit, tree, tag, and blob objects fetched from a remote repository will generally be stored in pack files and may be removed separately with **gotadmin** **cleanup** and Git's garbage collector. - **checkout** \[**-Eq**\] \[**-b** *branch*\] \[**-c** *commit*\] \[**-p** *path-prefix*\] *repository-path* \[*work-tree-path*\] ``` (alias: co) ``` Copy files from a repository into a new work tree. Show the status of each affected file, using the following status codes: | | | | --- | --- | | A | new file was added | | E | file already exists in work tree's meta-data | - **update** \[**-q**\] \[**-b** *branch*\] \[**-c** *commit*\] \[*path* *...*\] ``` (alias: up) ``` Update an existing work tree to a different *commit*. Change existing files in the work tree as necessary to match file contents of this commit. Preserve any local changes in the work tree and merge them with the incoming changes. Files which already contain merge conflicts will not be updated to avoid further complications. Such files will be updated when **got** **update** is run again after merge conflicts have been resolved. If the conflicting changes are no longer needed, affected files can be reverted with **got** **revert** before running **got** **update** again. Show the status of each affected file, using the following status codes: | | | | --- | --- | | U | file was updated and contained no local changes | | G | file was updated and local changes were merged cleanly | | C | file was updated and conflicts occurred during merge | | D | file was deleted | | d | file's deletion was prevented by local modifications | | A | new file was added | | ~ | versioned file is obstructed by a non-regular file | | ! | a missing versioned file was restored | | # | file was not updated because it contains merge conflicts | | ? | changes destined for an unversioned file were not merged | - **status** \[**-I**\] \[**-S** *status-codes*\] \[**-s** *status-codes*\] \[*path* *...*\] ``` (alias: st) ``` Show the current modification status of files in a work tree, using the following status codes: | | | | --- | --- | | M | modified file | | A | file scheduled for addition in next commit | | D | file scheduled for deletion in next commit | | C | modified or added file which contains merge conflicts | | ! | versioned file was expected on disk but is missing | | ~ | versioned file is obstructed by a non-regular file | | ? | unversioned item not tracked by | | m | modified file modes (executable bit only) | | N | non-existent | - **log** \[**-bdPpRst**\] \[**-C** *number*\] \[**-c** *commit*\] \[**-l** *N*\] \[**-r** *repository-path*\] \[**-S** *search-pattern*\] \[**-x** *commit*\] \[*path*\] Display history of a repository. If a *path* is specified, show only commits which modified this path. If invoked in a work tree, the *path* is interpreted relative to the current working directory, and the work tree's path prefix is implicitly prepended. Otherwise, the path is interpreted relative to the repository root. The options for **got** **log** are as follows: - **-b** Display individual commits which were merged into the current branch from other branches. By default, **got** **log** shows the linear history of the current branch only. - **-C** *number* Set the number of context lines shown in diffs with **-p**. By default, 3 lines of context are shown. - **-c** *commit* Start traversing history at the specified *commit*. If this option is not specified, default to the work tree's current branch if invoked in a work tree, or to the repository's HEAD reference. The expected *commit* argument is a commit ID, or a reference name or a keyword which will be resolved to a commit ID. An abbreviated hash argument will be expanded to a full commit ID automatically, provided the abbreviation is unique. The keywords ":base" and ":head" resolve to the work tree's base commit and branch head, respectively. The former is only valid if invoked in a work tree, while the latter will resolve to the tip of the work tree's current branch if invoked in a work tree, otherwise it will resolve to the repository's HEAD reference. Keywords and references may be appended with ":+" or ":-" modifiers and an optional integer N to denote the Nth descendant or antecedent, respectively, by first parent traversal; for example, **:head:-2** denotes the HEAD reference's 2nd generation ancestor, and **:base:+4** denotes the 4th generation descendant of the work tree's base commit. Similarly, **bar:+3** will denote the 3rd generation descendant of the commit resolved by the "bar" reference. A ":+" or ":-" modifier without a trailing integer has an implicit "1" appended (e.g., **:base:+** is equivalent to **:base:+1**). - **-d** Display diffstat of changes introduced in each commit. Cannot be used with the **-s** option. Implies the **-P** option (diffstat displays a list of changed paths). - **-l** *N* Limit history traversal to a given number of commits. If this option is not specified, a default limit value of zero is used, which is treated as an unbounded limit. The GOT\_LOG\_DEFAULT\_LIMIT environment variable may be set to change this default value. - **-P** Display the list of file paths changed in each commit, using the following status codes: | | | | --- | --- | | M | modified file | | D | file was deleted | | A | new file was added | | m | modified file modes (executable bit only) | - **-p** Display the patch of modifications made in each commit. If a *path* is specified, only show the patch of modifications at or within this path. Cannot be used with the **-s** option. - **-R** Determine a set of commits to display as usual, but display these commits in reverse order. - **-r** *repository-path* Use the repository at the specified path. If not specified, assume the repository is located at or above the current working directory. If this directory is a **got** work tree, use the repository path associated with this work tree. - **-S** *search-pattern* If specified, show only commits with a log message, author name, committer name, or commit ID matched by the extended regular expression *search-pattern*. Lines in committed patches will be matched if **-p** is specified. File paths changed by a commit will be matched if **-P** is specified. Regular expression syntax is documented in [re\_format(7)](/re_format/7.md). - **-s** Display a short one-line summary of each commit, instead of the default history format. Cannot be used together with the **-p** or **-P** option. - **-t** Display commits in topological order. This option has no effect without the **-b** option because a linear history is sorted in topological order by definition. Topological sorting is disabled by default because the present implementation requires that commit history is fully traversed before any output can be shown. - **-x** *commit* Stop traversing commit history immediately after the specified *commit* has been traversed. Like **-c**, the expected *commit* argument is a commit ID, or a reference name or a keyword which will be resolved to a commit ID. This option has no effect if the specified *commit* is never traversed. - **diff** \[**-adPsw**\] \[**-C** *number*\] \[**-c** *commit*\] \[**-r** *repository-path*\] \[*object1* *object2* \| *path* *...*\] ``` (alias: di) ``` When invoked within a work tree without any arguments, display all local changes in the work tree. If one or more *path* arguments are specified, only show changes within the specified paths. If two arguments are provided, treat each argument as a reference, a tag name, or an object ID, and display differences between the corresponding objects. Both objects must be of the same type (blobs, trees, or commits). An abbreviated hash argument will be expanded to a full commit ID automatically, provided the abbreviation is unique. If none of these interpretations produce a valid result or if the **-P** option is used, and if **got** **diff** is running in a work tree, attempt to interpret the two arguments as paths. The options for **got** **diff** are as follows: - **-a** Treat file contents as ASCII text even if binary data is detected. - **-C** *number* Set the number of context lines shown in the diff. By default, 3 lines of context are shown. - **-c** *commit* Show differences between commits in the repository. This option may be used up to two times. When used only once, show differences between the specified *commit* and its first parent commit. When used twice, show differences between the two specified commits. If the **-c** option is used, all non-option arguments will be interpreted as paths. If one or more such *path* arguments are provided, only show differences for the specified paths. The expected *commit* argument is a commit ID, or a reference name or a keyword which will be resolved to a commit ID. An abbreviated hash argument will be expanded to a full commit ID automatically, provided the abbreviation is unique. The keywords ":base" and ":head" resolve to the work tree's base commit and branch head, respectively. The former is only valid if invoked in a work tree, while the latter will resolve to the tip of the work tree's current branch if invoked in a work tree, otherwise it will resolve to the repository's HEAD reference. Keywords and references may be appended with ":+" or ":-" modifiers and an optional integer N to denote the Nth descendant or antecedent, respectively, by first parent traversal; for example, **:head:-2** denotes the HEAD reference's 2nd generation ancestor, and **:base:+4** denotes the 4th generation descendant of the work tree's base commit. Similarly, **baz:+8** will denote the 8th generation descendant of the commit resolved by the "baz" reference. If an integer does not follow the ":+" or ":-" modifier, a "1" is implicitly appended (e.g., **:head:-** is equivalent to **:head:-1**). Cannot be used together with the **-P** option. - **-d** Display diffstat of changes before the actual diff by annotating each file path or blob hash being diffed with the total number of lines added and removed. A summary line will display the total number of changes across all files. - **-P** Interpret all arguments as paths only. This option can be used to resolve ambiguity in cases where paths look like tag names, reference names, or object IDs. This option is only valid when **got** **diff** is invoked in a work tree. - **-r** *repository-path* Use the repository at the specified path. If not specified, assume the repository is located at or above the current working directory. If this directory is a **got** work tree, use the repository path associated with this work tree. - **-s** Show changes staged with **got** **stage** instead of showing local changes in the work tree. This option is only valid when **got** **diff** is invoked in a work tree. - **-w** Ignore whitespace-only changes. - **blame** \[**-c** *commit*\] \[**-r** *repository-path*\] *path* ``` (alias: bl) ``` Display line-by-line history of a file at the specified path. The options for **got** **blame** are as follows: - **-c** *commit* Start traversing history at the specified *commit*. The expected argument is a commit ID, or a reference name or a keyword which will be resolved to a commit ID. An abbreviated hash argument will be expanded to a full commit ID automatically, provided the abbreviation is unique. The keywords ":base" and ":head" resolve to the work tree's base commit and branch head, respectively. The former is only valid if invoked in a work tree, while the latter will resolve to the tip of the work tree's current branch if invoked in a work tree, otherwise it will resolve to the repository's HEAD reference. Keywords and references may be appended with ":+" or ":-" modifiers and an optional integer N to denote the Nth descendant or antecedent by first parent traversal, respectively; for example, **:head:-2** denotes the work tree branch head's 2nd generation ancestor, and **:base:+4** denotes the 4th generation descendant of the work tree's base commit. Similarly, **xyz:-5** will denote the 5th generation ancestor of the commit resolved by the "xyz" reference. A ":+" or ":-" modifier without a trailing integer has an implicit "1" appended (e.g., **:base:+** is equivalent to **:base:+1**). - **-r** *repository-path* Use the repository at the specified path. If not specified, assume the repository is located at or above the current working directory. If this directory is a **got** work tree, use the repository path associated with this work tree. - **tree** \[**-iR**\] \[**-c** *commit*\] \[**-r** *repository-path*\] \[*path*\] ``` (alias: tr) ``` Display a listing of files and directories at the specified directory path in the repository. Entries shown in this listing may carry one of the following trailing annotations: | | | | --- | --- | | @ | entry is a symbolic link | | / | entry is a directory | | \* | entry is an executable file | | $ | entry is a Git submodule | - **ref** \[**-dlt**\] \[**-c** *object*\] \[**-r** *repository-path*\] \[**-s** *reference*\] \[*name*\] Manage references in a repository. References may be listed, created, deleted, and changed. When creating, deleting, or changing a reference the specified *name* must be an absolute reference name, i.e. it must begin with “refs/”. The options for **got** **ref** are as follows: - **-c** *object* Create a reference or change an existing reference. The reference with the specified *name* will point at the specified *object*. The expected *object* argument is an object ID or an existing reference or tag name or a keyword which will be resolved to the ID of a corresponding commit, tree, tag, or blob object. An abbreviated hash argument will be expanded to a full commit ID automatically, provided the abbreviation is unique. The keywords ":base" and ":head" resolve to the work tree's base commit and branch head, respectively. The former is only valid if invoked in a work tree, while the latter will resolve to the tip of the work tree's current branch if invoked in a work tree, otherwise it will resolve to the repository's HEAD reference. Keywords and reference names may be appended with ":+" or ":-" modifiers and an optional integer N to denote the Nth descendant or antecedent by first parent traversal, respectively; for example, **:head:-2** denotes the work tree branch head's 2nd generation ancestor, and **tagged:-3** will denote the 3rd generation ancestor of the commit resolved by the "tagged" reference. If an integer does not follow the ":+" or ":-" modifier, a "1" is implicitly appended (e.g., **:head:-** is equivalent to **:head:-1**). Cannot be used together with any other options except **-r**. - **-d** Delete the reference with the specified *name* from the repository. Any commit, tree, tag, and blob objects belonging to deleted references remain in the repository and may be removed separately with Git's garbage collector or **gotadmin** **cleanup**. Cannot be used together with any other options except **-r**. - **-l** List references in the repository. If no *name* is specified, list all existing references in the repository. If *name* is a reference namespace, list all references in this namespace. Otherwise, show only the reference with the given *name*. Cannot be used together with any other options except **-r** and **-t**. - **-r** *repository-path* Use the repository at the specified path. If not specified, assume the repository is located at or above the current working directory. If this directory is a **got** work tree, use the repository path associated with this work tree. - **-s** *reference* Create a symbolic reference, or change an existing symbolic reference. The symbolic reference with the specified *name* will point at the specified *reference* which must already exist in the repository. Care should be taken not to create loops between references when this option is used. Cannot be used together with any other options except **-r**. - **-t** Sort listed references by modification time (most recently modified first) instead of sorting by lexicographical order. Use of this option requires the **-l** option to be used as well. - **branch** \[**-lnt**\] \[**-c** *commit*\] \[**-d** *name*\] \[**-r** *repository-path*\] \[*name*\] ``` (alias: br) ``` Create, list, or delete branches. Local branches are managed via references which live in the “refs/heads/” reference namespace. The **got** **branch** command creates references in this namespace only. When deleting branches, the specified *name* is searched in the “refs/heads” reference namespace first. If no corresponding branch is found, the “refs/remotes” namespace will be searched next. If invoked in a work tree without any arguments, print the name of the work tree's current branch. If a *name* argument is passed, attempt to create a branch reference with the given name. By default the new branch reference will point at the latest commit on the work tree's current branch if invoked in a work tree, and otherwise to a commit resolved via the repository's HEAD reference. If invoked in a work tree, once the branch was created successfully switch the work tree's head reference to the newly created branch and update files across the entire work tree, just like **got** **update** **-b** *name* would do. Show the status of each affected file, using the following status codes: | | | | --- | --- | | U | file was updated and contained no local changes | | G | file was updated and local changes were merged cleanly | | C | file was updated and conflicts occurred during merge | | D | file was deleted | | A | new file was added | | ~ | versioned file is obstructed by a non-regular file | | ! | a missing versioned file was restored | - **tag** \[**-lsVv**\] \[**-c** *commit*\] \[**-m** *message*\] \[**-r** *repository-path*\] \[**-S** *signer-id*\] *name* Manage tags in a repository. Tags are managed via references which live in the “refs/tags/” reference namespace. The **got** **tag** command operates on references in this namespace only. References in this namespace point at tag objects which contain a pointer to another object, a tag message, as well as author and timestamp information. Attempt to create a tag with the given *name*, and make this tag point at the given *commit*. If no commit is specified, default to the latest commit on the work tree's current branch if invoked in a work tree, and to a commit resolved via the repository's HEAD reference otherwise. The options for **got** **tag** are as follows: - **-c** *commit* Make the newly created tag reference point at the specified *commit*. The expected *commit* argument is a commit ID, or a reference or keyword which will be resolved to a commit ID. An abbreviated hash argument will be expanded to a full commit ID automatically, provided the abbreviation is unique. The keywords ":base" and ":head" resolve to the work tree's base commit and branch head, respectively. The former is only valid if invoked in a work tree, while the latter will resolve to the tip of the work tree's current branch if invoked in a work tree, otherwise it will resolve to the repository's HEAD reference. Keywords and references may be appended with ":+" or ":-" modifiers and an optional integer N to denote the Nth descendant or antecedent by first parent traversal, respectively; for example, **:head:-2** denotes the work tree branch head's 2nd generation ancestor, and **:base:+4** denotes the 4th generation descendant of the work tree's base commit. Similarly, **eggs:-3** will denote the 3rd generation ancestor of the commit resolved by the "eggs" reference. A ":+" or ":-" modifier without a trailing integer has an implicit "1" appended (e.g., **:base:+** is equivalent to **:base:+1**). - **-l** List all existing tags in the repository instead of creating a new tag. If a *name* argument is passed, show only the tag with the given *name*. - **-m** *message* Use the specified tag message when creating the new tag. Without the **-m** option, **got** **tag** opens a temporary file in an editor where a tag message can be written. Quitting the editor without saving the file will abort the tag operation. - **-r** *repository-path* Use the repository at the specified path. If not specified, assume the repository is located at or above the current working directory. If this directory is a **got** work tree, use the repository path associated with this work tree. - **-S** *signer-id* While creating a new tag, sign this tag with the identity given in *signer-id*. For SSH-based signatures, *signer-id* is the path to a file which may refer to either a private SSH key, or a public SSH key with the private half available via [ssh-agent(1)](/ssh-agent/1.md). **got** **tag** will sign the tag object by invoking [ssh-keygen(1)](/ssh-keygen/1.md) with the **-Y** **sign** command, using the signature namespace “git” for compatibility with [git(1)](/git/1.md). - **-s** Display a short one-line summary of each tag, instead of the default history format. Can only be used with the **-l** option. - **-V** Verify tag object signatures. If a *name* is specified, show and verify the tag object with the provided name. Otherwise, list all tag objects and verify signatures where present. **got** **tag** verifies SSH-based signatures by invoking [ssh-keygen(1)](/ssh-keygen/1.md) with the options **-Y** **verify** **-f** *allowed\_signers*. A path to the *allowed\_signers* file must be set in [got.conf(5)](/got.conf/5.md), otherwise verification is impossible. - **-v** Verbose mode. During SSH signature creation and verification this option will be passed to [ssh-keygen(1)](/ssh-keygen/1.md). Multiple -v options increase the verbosity. The maximum is 3. By design, the **got** **tag** command will not delete tags or change existing tags. If a tag must be deleted, the **got** **ref** command may be used to delete a tag's reference. This should only be done if the tag has not already been copied to another repository. - **add** \[**-IR**\] *path* *...* Schedule unversioned files in a work tree for addition to the repository in the next commit. By default, files which match a **got** **status** ignore pattern will not be added. If a *path* mentioned in the command line is not an unversioned file then **got** **add** may raise an error. To avoid unnecessary errors from paths picked up by file globbing patterns in the shell, paths in the argument list will be silently ignored if they are not reported by **got** **status** at all, or if they are reported with one of the following status codes and do not have changes staged via **got** **stage**: | | | | --- | --- | | M | modified file | | A | file scheduled for addition in next commit | | C | modified or added file which contains merge conflicts | | m | modified file modes (executable bit only) | - **remove** \[**-fkR**\] \[**-s** *status-codes*\] *path* *...* ``` (alias: rm) ``` Remove versioned files from a work tree and schedule them for deletion from the repository in the next commit. The options for **got** **remove** are as follows: - **-f** Perform the operation even if a file contains local modifications, and do not raise an error if a specified *path* does not exist on disk. - **-k** Keep affected files on disk. - **-R** Permit recursion into directories. If this option is not specified, **got** **remove** will refuse to run if a specified *path* is a directory. - **-s** *status-codes* Only delete files with a modification status matching one of the single-character status codes contained in the *status-codes* argument. The following status codes may be specified: | | | | --- | --- | | M | modified file (this implies the | | ! | versioned file expected on disk but missing | - **patch** \[**-nR**\] \[**-c** *commit*\] \[**-p** *strip-count*\] \[*patchfile*\] ``` (alias: pa) ``` Apply changes from *patchfile* to files in a work tree. Files added or removed by a patch will be scheduled for addition or removal in the work tree. The patch must be in the unified diff format as produced by **got** **diff**, [git-diff(1)](/git-diff/1.md), or by [diff(1)](/diff/1.md) and [cvs(1)](/cvs/1.md) diff when invoked with their **-u** options. If no *patchfile* argument is provided, read unified diff data from standard input instead. If the *patchfile* contains multiple patches, then attempt to apply each of them in sequence. Show the status of each affected file, using the following status codes: | | | | --- | --- | | M | file was modified | | G | file was merged using a merge-base found in the repository | | C | file was merged and conflicts occurred during merge | | D | file was deleted | | A | file was added | | # | failed to patch the file | - **revert** \[**-pR**\] \[**-F** *response-script*\] *path* *...* ``` (alias: rv) ``` Revert any local changes in files at the specified paths in a work tree. File contents will be overwritten with those contained in the work tree's base commit. There is no way to bring discarded changes back after **got** **revert**! If a file was added with **got** **add**, it will become an unversioned file again. If a file was deleted with **got** **remove**, it will be restored. The options for **got** **revert** are as follows: - **-F** *response-script* With the **-p** option, read “y”, “n”, and “q” responses line-by-line from the specified *response-script* file instead of prompting interactively. - **-p** Instead of reverting all changes in files, interactively select or reject changes to revert based on “y” (revert change), “n” (keep change), and “q” (quit reverting this file) responses. If a file is in modified status, individual patches derived from the modified file content can be reverted. Files in added or deleted status may only be reverted in their entirety. - **-R** Permit recursion into directories. If this option is not specified, **got** **revert** will refuse to run if a specified *path* is a directory. - **commit** \[**-CNnS**\] \[**-A** *author*\] \[**-F** *path*\] \[**-m** *message*\] \[*path* *...*\] ``` (alias: ci) ``` Create a new commit in the repository from changes in a work tree and use this commit as the new base commit for the work tree. If no *path* is specified, commit all changes in the work tree. Otherwise, commit changes at or within the specified paths. If changes have been explicitly staged for commit with **got** **stage**, only commit staged changes and reject any specified paths which have not been staged. **got** **commit** opens a temporary file in an editor where a log message can be written unless the **-m** option is used or the **-F** and **-N** options are used together. Quitting the editor without saving the file will abort the commit operation. Show the status of each affected file, using the following status codes: | | | | --- | --- | | M | modified file | | D | file was deleted | | A | new file was added | | m | modified file modes (executable bit only) | - **send** \[**-afqTv**\] \[**-b** *branch*\] \[**-d** *branch*\] \[**-i** *identity-file*\] \[**-J** *jumphost*\] \[**-r** *repository-path*\] \[**-t** *tag*\] \[*remote-repository*\] ``` (alias: se) ``` Send new changes to a remote repository. If no *remote-repository* is specified, “origin” will be used. The remote repository's URL is obtained from the corresponding entry in [got.conf(5)](/got.conf/5.md) or Git's *config* file of the local repository, as created by **got** **clone**. All objects corresponding to new changes will be written to a temporary pack file which is then uploaded to the server. Upon success, references in the “refs/remotes/” reference namespace of the local repository will be updated to point at the commits which have been sent. By default, changes will only be sent if they are based on up-to-date copies of relevant branches in the remote repository. If any changes to be sent are based on out-of-date copies or would otherwise break linear history of existing branches, new changes must be fetched from the server with **got** **fetch** and local branches must be rebased with **got** **rebase** before **got** **send** can succeed. The **-f** option can be used to make exceptions to these requirements. The options for **got** **send** are as follows: - **-a** Send all branches from the local repository's “refs/heads/” reference namespace. The **-a** option is equivalent to listing all branches with multiple **-b** options. Cannot be used together with the **-b** option. - **-b** *branch* Send the specified *branch* from the local repository's “refs/heads/” reference namespace. This option may be specified multiple times to build a list of branches to send. If this option is not specified, default to the work tree's current branch if invoked in a work tree, or to the repository's HEAD reference. Cannot be used together with the **-a** option. - **-d** *branch* Delete the specified *branch* from the remote repository's “refs/heads/” reference namespace. This option may be specified multiple times to build a list of branches to delete. Only references are deleted. Any commit, tree, tag, and blob objects belonging to deleted branches may become subject to deletion by Git's garbage collector running on the server. Requesting deletion of branches results in an error if the server does not support this feature or disallows the deletion of branches based on its configuration. - **-f** Attempt to force the server to overwrite existing branches or tags in the remote repository, even when **got** **fetch** followed by **got** **rebase** or **got** **merge** would usually be required before changes can be sent. The server may reject forced requests regardless, depending on its configuration. Any commit, tree, tag, and blob objects belonging to overwritten branches or tags may become subject to deletion by Git's garbage collector running on the server. The “refs/tags” reference namespace is globally shared between all repositories. Use of the **-f** option to overwrite tags is discouraged because it can lead to inconsistencies between the tags present in different repositories. In general, creating a new tag with a different name is recommended instead of overwriting an existing tag. Use of the **-f** option is particularly discouraged if changes being sent are based on an out-of-date copy of a branch in the remote repository. Instead of using the **-f** option, new changes should be fetched with **got** **fetch** and local branches should be rebased with **got** **rebase** or merged with **got** **merge**, followed by another attempt to send the changes. The **-f** option should only be needed in situations where the remote repository's copy of a branch or tag is known to be out-of-date and is considered disposable. The risks of creating inconsistencies between different repositories should also be taken into account. - **-i** *identity-file* Specify an *identity-file*, containing a private SSH key, to use with SSH connections. The same option will be passed to [ssh(1)](/ssh/1.md). - **-J** *jumphost* Specify a *jumphost* to use with SSH connections. The same option will be passed to [ssh(1)](/ssh/1.md). - **-q** Suppress progress reporting output. The same option will be passed to [ssh(1)](/ssh/1.md) if applicable. - **-r** *repository-path* Use the repository at the specified path. If not specified, assume the repository is located at or above the current working directory. If this directory is a **got** work tree, use the repository path associated with this work tree. - **-T** Attempt to send all tags from the local repository's “refs/tags/” reference namespace. The **-T** option is equivalent to listing all tags with multiple **-t** options. Cannot be used together with the **-t** option. - **-t** *tag* Send the specified *tag* from the local repository's “refs/tags/” reference namespace, in addition to any branches that are being sent. The **-t** option may be specified multiple times to build a list of tags to send. No tags will be sent if the **-t** option is not used. Raise an error if the specified *tag* already exists in the remote repository, unless the **-f** option is used to overwrite the server's copy of the tag. In general, creating a new tag with a different name is recommended instead of overwriting an existing tag. Cannot be used together with the **-T** option. - **-v** Verbose mode. Causes **got** **send** to print debugging messages to standard error output. The same option will be passed to [ssh(1)](/ssh/1.md) if applicable. Multiple -v options increase the verbosity. The maximum is 3. - **cherrypick** \[**-lX**\] \[*commit*\] ``` (alias: cy) ``` Merge changes from a single *commit* into the work tree. The specified *commit* should be on a different branch than the work tree's base commit. The expected argument is a commit ID, or a reference name or keyword which will be resolved to a commit ID. An abbreviated hash argument will be expanded to a full commit ID automatically, provided the abbreviation is unique. The keywords ":base" and ":head" resolve to the work tree's base commit and branch head, respectively. Keywords and references may be appended with ":+" or ":-" modifiers and an optional integer N to denote the Nth descendant or antecedent by first parent traversal, respectively; for example, **:head:-2** denotes the work tree branch head's 2nd generation ancestor, and **:base:+4** denotes the 4th generation descendant of the work tree's base commit. Similarly, **barbaz:+3** will denote the 3rd generation descendant of the commit resolved by the "barbaz" reference. A ":+" or ":-" modifier without a trailing integer has an implicit "1" appended (e.g., **:base:+** is equivalent to **:base:+1**). Show the status of each affected file, using the following status codes: | | | | --- | --- | | G | file was merged | | C | file was merged and conflicts occurred during merge | | ! | changes destined for a missing file were not merged | | D | file was deleted | | d | file's deletion was prevented by local modifications | | A | new file was added | | ~ | changes destined for a non-regular file were not merged | | ? | changes destined for an unversioned file were not merged | - **backout** \[**-lX**\] \[*commit*\] ``` (alias: bo) ``` Reverse-merge changes from a single *commit* into the work tree. The specified *commit* should be on the same branch as the work tree's base commit. The expected argument is a commit ID, or a reference name or keyword which will be resolved to a commit ID. An abbreviated hash argument will be expanded to a full commit ID automatically, provided the abbreviation is unique. The keywords ":base" and ":head" resolve to the work tree's base commit and branch head, respectively. Keywords and references may be appended with ":+" or ":-" modifiers and an optional integer N to denote the Nth descendant or antecedent by first parent traversal, respectively; for example, **:head:-2** denotes the work tree branch head's 2nd generation ancestor, and **:base:+4** denotes the 4th generation descendant of the work tree's base commit. Similarly, **wip:+5** will denote the 5th generation descendant of the commit resolved by the "wip" reference. A ":+" or ":-" modifier without a trailing integer has an implicit "1" appended (e.g., **:base:+** is equivalent to **:base:+1**). Show the status of each affected file, using the following status codes: | | | | --- | --- | | G | file was merged | | C | file was merged and conflicts occurred during merge | | ! | changes destined for a missing file were not merged | | D | file was deleted | | d | file's deletion was prevented by local modifications | | A | new file was added | | ~ | changes destined for a non-regular file were not merged | | ? | changes destined for an unversioned file were not merged | - **rebase** \[**-aCclX**\] \[*branch*\] ``` (alias: rb) ``` Rebase commits on the specified *branch* onto the tip of the current branch of the work tree. The *branch* must share common ancestry with the work tree's current branch. Rebasing begins with the first descendant commit of the youngest common ancestor commit shared by the specified *branch* and the work tree's current branch, and stops once the tip commit of the specified *branch* has been rebased. When **got** **rebase** is used as intended, the specified *branch* represents a local commit history and may already contain changes that are not yet visible in any other repositories. The work tree's current branch, which must be set with **got** **update** **-b** before starting the **rebase** operation, represents a branch from a remote repository which shares a common history with the specified *branch* but has progressed, and perhaps diverged, due to commits added to the remote repository. Rebased commits are accumulated on a temporary branch which the work tree will remain switched to throughout the entire rebase operation. Commits on this branch represent the same changes with the same log messages as their counterparts on the original *branch*, but with different commit IDs. Once rebasing has completed successfully, the temporary branch becomes the new version of the specified *branch* and the work tree is automatically switched to it. If author information is available via the GOT\_AUTHOR environment variable, [got.conf(5)](/got.conf/5.md) or Git's user.name and user.email configuration settings, this author information will be used to identify the “committer” of rebased commits. Old commits in their pre-rebase state are automatically backed up in the “refs/got/backup/rebase” reference namespace. As long as these references are not removed older versions of rebased commits will remain in the repository and can be viewed with the **got** **rebase** **-l** command. Removal of these references makes objects which become unreachable via any reference subject to removal by Git's garbage collector or **gotadmin** **cleanup**. While rebasing commits, show the status of each affected file, using the following status codes: | | | | --- | --- | | G | file was merged | | C | file was merged and conflicts occurred during merge | | ! | changes destined for a missing file were not merged | | D | file was deleted | | d | file's deletion was prevented by local modifications | | A | new file was added | | ~ | changes destined for a non-regular file were not merged | | ? | changes destined for an unversioned file were not merged | - **histedit** \[**-aCcdeflmX**\] \[**-F** *histedit-script*\] \[*branch*\] ``` (alias: he) ``` Edit commit history between the work tree's current base commit and the tip commit of the work tree's current branch. The **got** **histedit** command requires the GOT\_AUTHOR environment variable to be set, unless an author has been configured in [got.conf(5)](/got.conf/5.md) or Git's user.name and user.email configuration settings can be obtained from the repository's *.git/config* file or from Git's global *~/.gitconfig* configuration file. Before starting a **histedit** operation, the work tree's current branch must be set with **got** **update** **-b** to the branch which should be edited, unless this branch is already the current branch of the work tree. The tip of this branch represents the upper bound (inclusive) of commits touched by the **histedit** operation. Furthermore, the work tree's base commit must be set with **got** **update** **-c** to a point in this branch's commit history where editing should begin. This commit represents the lower bound (non-inclusive) of commits touched by the **histedit** operation. Editing of commit history is controlled via a *histedit* *script* which can be written in an editor based on a template, passed on the command line, or generated with the **-d**, **-e**, **-f**, or **-m** options. Quitting the editor without saving the file will abort the histedit operation. The format of the histedit script is line-based. Each line in the script begins with a command name, followed by whitespace and an argument. For most commands, the expected argument is a commit ID. Any remaining text on the line is ignored. Lines which begin with the ‘#’ character are ignored entirely. The available histedit script commands are as follows: | | | | --- | --- | | **pick** *commit* | Use the specified commit as it is. | | **edit** *commit* | Apply the changes from the specified commit, but | | **fold** *commit* | Combine the specified commit with the next commit | | **drop** *commit* | Remove this commit from the edited history. | | **mesg** *commit* | Open an editor to create a new log message for this | - **integrate** *branch* ``` (alias: ig) ``` Integrate the specified *branch* into the work tree's current branch. Files in the work tree are updated to match the contents on the integrated *branch*, and the reference of the work tree's branch is changed to point at the head commit of the integrated *branch*. Both branches can be considered equivalent after integration since they will be pointing at the same commit. Both branches remain available for future work, if desired. In case the integrated *branch* is no longer needed it may be deleted with **got** **branch** **-d**. Show the status of each affected file, using the following status codes: | | | | --- | --- | | U | file was updated | | D | file was deleted | | A | new file was added | | ~ | versioned file is obstructed by a non-regular file | | ! | a missing versioned file was restored | - **merge** \[**-aCcMn**\] \[*branch*\] ``` (alias: mg) ``` Merge the specified *branch* into the current branch of the work tree. If the branches have diverged, merge changes into the work tree and create a merge commit. Otherwise, if the specified *branch* is already based on the work tree's current branch, make the work tree's current branch equivalent to the specified *branch* and update files in the work tree accordingly. Merge commits are commits based on multiple parent commits. The tip commit of the work tree's current branch will be used as the first parent. The tip commit of the specified *branch* will be used as the second parent. The work tree's current branch must be in the “refs/heads/” reference namespace and can be set with **got** **update** **-b** before starting the **merge** operation. No ancestral relationship between the two branches is required. If the two branches have already been merged previously, only new changes will be merged. It is not possible to create merge commits with more than two parents. If more than one branch needs to be merged, then multiple merge commits with two parents each can be created in sequence. If a linear project history is desired, then use of **got** **rebase** should generally be preferred over **got** **merge**. However, even strictly linear projects may require occasional merge commits, for example in order to merge in new versions of third-party code stored on “vendor” branches created with **got** **import**. While merging changes found on the *branch* into the work tree, show the status of each affected file, using the following status codes: | | | | --- | --- | | U | file was updated | | G | file was merged | | C | file was merged and conflicts occurred during merge | | ! | changes destined for a missing file were not merged | | D | file was deleted | | d | file's deletion was prevented by local modifications | | A | new file was added | | ~ | changes destined for a non-regular file were not merged | | ? | changes destined for an unversioned file were not merged | - **stage** \[**-lpS**\] \[**-F** *response-script*\] \[*path* *...*\] ``` (alias: sg) ``` Stage local changes for inclusion in the next commit. If no *path* is specified, stage all changes in the work tree. Otherwise, stage changes at or within the specified paths. Paths may be staged if they are added, modified, or deleted according to **got** **status**. Show the status of each affected file, using the following status codes: | | | | --- | --- | | A | file addition has been staged | | M | file modification has been staged | | D | file deletion has been staged | - **unstage** \[**-p**\] \[**-F** *response-script*\] \[*path* *...*\] ``` (alias: ug) ``` Merge staged changes back into the work tree and put affected paths back into non-staged status. If no *path* is specified, unstage all staged changes across the entire work tree. Otherwise, unstage changes at or within the specified paths. Show the status of each affected file, using the following status codes: | | | | --- | --- | | G | file was unstaged | | C | file was unstaged and conflicts occurred during merge | | ! | changes destined for a missing file were not merged | | D | file was staged as deleted and still is deleted | | d | file's deletion was prevented by local modifications | | ~ | changes destined for a non-regular file were not merged | - **cat** \[**-P**\] \[**-c** *commit*\] \[**-r** *repository-path*\] *arg* *...* Parse and print contents of objects to standard output in a line-based text format. Content of commit, tree, and tag objects is printed in a way similar to the actual content stored in such objects. Blob object contents are printed as they would appear in files on disk. Attempt to interpret each argument as a reference, a tag name, or an object ID. References will be resolved to an object ID. Tag names will resolved to a tag object. An abbreviated hash argument will be expanded to a full commit ID automatically, provided the abbreviation is unique. If none of the above interpretations produce a valid result, or if the **-P** option is used, attempt to interpret the argument as a path which will be resolved to the ID of an object found at this path in the repository. The options for **got** **cat** are as follows: - **-c** *commit* Look up paths in the specified *commit*. If this option is not used, paths are looked up in the commit resolved via the repository's HEAD reference. The expected argument is a commit ID, or a reference name or keyword which will be resolved to a commit ID. An abbreviated hash argument will be expanded to a full commit ID automatically, provided the abbreviation is unique. The keywords ":base" and ":head" resolve to the work tree's base commit and branch head, respectively. The former is only valid if invoked in a work tree, while the latter will resolve to the tip of the work tree's current branch if invoked in a work tree, otherwise it will resolve to the repository's HEAD reference. Keywords and references may be appended with ":+" or ":-" modifiers and an optional integer N to denote the Nth descendant or antecedent by first parent traversal, respectively; for example, **:head:-2** denotes the work tree branch head's 2nd generation ancestor, and **:base:+4** denotes the 4th generation descendant of the work tree's base commit. Similarly, **quux:-8** will denote the 8th generation ancestor of the commit resolved by the "quux" reference. A ":+" or ":-" modifier without a trailing integer has an implicit "1" appended (e.g., **:base:+** is equivalent to **:base:+1**). - **-P** Interpret all arguments as paths only. This option can be used to resolve ambiguity in cases where paths look like tag names, reference names, or object IDs. - **-r** *repository-path* Use the repository at the specified path. If not specified, assume the repository is located at or above the current working directory. If this directory is a **got** work tree, use the repository path associated with this work tree. - **info** \[*path* *...*\] Display meta-data stored in a work tree. See [got-worktree(5)](/got-worktree/5.md) for details. The work tree to use is resolved implicitly by walking upwards from the current working directory. If one or more *path* arguments are specified, show additional per-file information for tracked files located at or within these paths. If a *path* argument corresponds to the work tree's root directory, display information for all tracked files. ## ENVIRONMENT - GOT\_AUTHOR The author's name and email address, such as "Flan Hacker ⟨*flan\_hacker@openbsd.org*⟩". Used by the **got** **commit**, **got** **import**, **got** **rebase**, **got** **merge**, and **got** **histedit** commands. Because [git(1)](/git/1.md) may fail to parse commits without an email address in author data, **got** attempts to reject GOT\_AUTHOR environment variables with a missing email address. GOT\_AUTHOR will be overridden by configuration settings in [got.conf(5)](/got.conf/5.md) or by Git's user.name and user.email configuration settings in the repository's *.git/config* file. The user.name and user.email configuration settings contained in Git's global *~/.gitconfig* configuration file will only be used if neither [got.conf(5)](/got.conf/5.md) nor the GOT\_AUTHOR environment variable provide author information. - GOT\_IGNORE\_GITCONFIG If this variable is set then any remote repository definitions or author information found in Git configuration files will be ignored. - GOT\_LOG\_DEFAULT\_LIMIT The default limit on the number of commits traversed by **got** **log**. If set to zero, the limit is unbounded. This variable will be silently ignored if it is set to a non-numeric value. - VISUAL, EDITOR The editor spawned by **got** **commit**, **got** **histedit**, **got** **import**, or **got** **tag**. If not set, the [vi(1)](/vi/1.md) text editor will be spawned. ## FILES - *got.conf* Repository-wide configuration settings for **got**. If present, a [got.conf(5)](/got.conf/5.md) configuration file located in the root directory of a Git repository supersedes any relevant settings in Git's *config* file. - *.got/got.conf* Worktree-specific configuration settings for **got**. If present, a [got.conf(5)](/got.conf/5.md) configuration file in the *.got* meta-data directory of a work tree supersedes any relevant settings in the repository's [got.conf(5)](/got.conf/5.md) configuration file and Git's *config* file. ## EXIT STATUS The **got** utility exits 0 on success, and \>0 if an error occurs. ## EXAMPLES Enable tab-completion of **got** command names in [ksh(1)](/ksh/1.md): ``` $ set -A complete_got_1 -- $(got -h 2>&1 | sed -n s/commands://p) ``` Clone an existing Git repository for use with **got**: ``` $ cd /var/git/ ``` ``` $ got clone ssh://git@github.com/openbsd/src.git ``` Unfortunately, many of the popular Git hosting sites do not offer anonymous access via SSH. Such sites will require an account to be created, and a public SSH key to be uploaded to this account, before repository access via ssh:// URLs will work. Most sites offer anonymous repository access via HTTPS: ``` $ cd /var/git/ ``` ``` $ got clone https://github.com/openbsd/src.git ``` Alternatively, for quick and dirty local testing of **got** a new Git repository could be created and populated with files, e.g. from a temporary CVS checkout located at */tmp/src*: ``` $ got init /var/git/src.git ``` ``` $ got import -r /var/git/src.git -I CVS -I obj /tmp/src ``` Check out a work tree from the Git repository to /usr/src: ``` $ got checkout /var/git/src.git /usr/src ``` View local changes in a work tree directory: ``` $ got diff | less ``` In a work tree, display files in a potentially problematic state: ``` $ got status -s 'C!~?' ``` Interactively revert selected local changes in a work tree directory: ``` $ got revert -p -R . ``` In a work tree or a git repository directory, list all branch references: ``` $ got branch -l ``` As above, but list the most recently modified branches only: ``` $ got branch -lt | head ``` In a work tree or a git repository directory, create a new branch called “unified-buffer-cache” which is forked off the “master” branch: ``` $ got branch -c master unified-buffer-cache ``` Switch an existing work tree to the branch “unified-buffer-cache”. Local changes in the work tree will be preserved and merged if necessary: ``` $ got update -b unified-buffer-cache ``` Create a new commit from local changes in a work tree directory. This new commit will become the head commit of the work tree's current branch: ``` $ got commit ``` In a work tree or a git repository directory, view changes committed in the 3 most recent commits to the work tree's branch, or the branch resolved via the repository's HEAD reference, respectively: ``` $ got log -p -l 3 ``` As above, but display changes in the order in which [patch(1)](/patch/1.md) could apply them in sequence: ``` $ got log -p -l 3 -R ``` In a work tree or a git repository directory, log the history of a subdirectory: ``` $ got log sys/uvm ``` While operating inside a work tree, paths are specified relative to the current working directory, so this command will log the subdirectory *sys/uvm*: ``` $ cd sys/uvm && got log . ``` And this command has the same effect: ``` $ cd sys/dev/usb && got log ../../uvm ``` And this command displays work tree meta-data about all tracked files: ``` $ cd /usr/src ``` ``` $ got info . | less ``` Add new files and remove obsolete files in a work tree directory: ``` $ got add sys/uvm/uvm_ubc.c ``` ``` $ got remove sys/uvm/uvm_vnode.c ``` A file can be renamed or moved by removing it from its old location and adding it at the new location: ``` $ cp oldfile.c newfile.c ``` ``` $ got remove oldfile.c ``` ``` $ got add newfile.c ``` **got** does not yet follow file history across renames, but [git(1)](/git/1.md) will be able to do so regardless. Create a new commit from local changes in a work tree directory with a pre-defined log message. ``` $ got commit -m 'unify the buffer cache' ``` Alternatively, create a new commit from local changes in a work tree directory with a log message that has been prepared in the file */tmp/msg*: ``` $ got commit -F /tmp/msg ``` Update any work tree checked out from the “unified-buffer-cache” branch to the latest commit on this branch: ``` $ got update ``` Roll file content on the unified-buffer-cache branch back by one commit, and then fetch the rolled-back change into the work tree as a local change to be amended and perhaps committed again: ``` $ got backout unified-buffer-cache ``` ``` $ got commit -m 'roll back previous' ``` ``` $ # now back out the previous backout :-) ``` ``` $ got backout unified-buffer-cache ``` Fetch new changes on the remote repository's “master” branch, making them visible on the local repository's “origin/master” branch: ``` $ cd /usr/src ``` ``` $ got fetch ``` Rebase the local “master” branch to merge the new changes that are now visible on the “origin/master” branch: ``` $ cd /usr/src ``` ``` $ got update -b origin/master ``` ``` $ got rebase master ``` Rebase the “unified-buffer-cache” branch on top of the new head commit of the “master” branch. ``` $ got update -b master ``` ``` $ got rebase unified-buffer-cache ``` Create a patch from all changes on the unified-buffer-cache branch. The patch can be mailed out for review and applied to OpenBSD's CVS tree: ``` $ got diff master unified-buffer-cache > /tmp/ubc.diff ``` Edit the entire commit history of the “unified-buffer-cache” branch: ``` $ got update -b unified-buffer-cache ``` ``` $ got update -c master ``` ``` $ got histedit ``` Before working against existing branches in a repository cloned with **git** **clone** **--bare** instead of **got** **clone**, a Git “refspec” must be configured to map all references in the remote repository into the “refs/remotes” namespace of the local repository. This can be achieved by setting Git's *remote.origin.fetch* configuration variable to the value “+refs/heads/\*:refs/remotes/origin/\*” with the **git** **config** command: ``` $ cd /var/git/repo ``` ``` $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*' ``` Additionally, the “mirror” option must be disabled: ``` $ cd /var/git/repo ``` ``` $ git config remote.origin.mirror false ``` Alternatively, the following [git-fetch(1)](/git-fetch/1.md) configuration item can be added manually to the Git repository's *config* file: ``` [remote "origin"] ``` ``` url = ... ``` ``` fetch = +refs/heads/*:refs/remotes/origin/* ``` ``` mirror = false ``` This configuration leaves the local repository's “refs/heads” namespace free for use by local branches checked out with **got** **checkout** and, if needed, created with **got** **branch**. Branches in the “refs/remotes/origin” namespace can now be updated with incoming changes from the remote repository with **got** **fetch** or [git-fetch(1)](/git-fetch/1.md) without extra command line arguments. Newly fetched changes can be examined with **got** **log**. Display changes on the remote repository's version of the “master” branch, as of the last time **got** **fetch** was run: ``` $ got log -c origin/master | less ``` As shown here, most commands accept abbreviated reference names such as “origin/master” instead of “refs/remotes/origin/master”. The latter is only needed in case of ambiguity. **got** **rebase** can be used to merge changes which are visible on the “origin/master” branch into the “master” branch. This will also merge local changes, if any, with the incoming changes: ``` $ got update -b origin/master ``` ``` $ got rebase master ``` In order to make changes committed to the “unified-buffer-cache” visible on the “master” branch, the “unified-buffer-cache” branch can be rebased onto the “master” branch: ``` $ got update -b master ``` ``` $ got rebase unified-buffer-cache ``` Changes on the “unified-buffer-cache” branch can now be made visible on the “master” branch with **got** **integrate**. Because the rebase operation switched the work tree to the “unified-buffer-cache” branch, the work tree must be switched back to the “master” branch first: ``` $ got update -b master ``` ``` $ got integrate unified-buffer-cache ``` On the “master” branch, log messages for local changes can now be amended with “OK” by other developers and any other important new information: ``` $ got update -c origin/master ``` ``` $ got histedit -m ``` If the remote repository offers write access, local changes on the “master” branch can be sent to the remote repository with **got** **send**. Usually, **got** **send** can be run without further arguments. The arguments shown here match defaults, provided the work tree's current branch is the “master” branch: ``` $ got send -b master origin ``` If the remote repository requires the HTTPS protocol, the [git-push(1)](/git-push/1.md) command must be used instead: ``` $ cd /var/git/src.git ``` ``` $ git push origin master ``` When making contributions to projects which use the “pull request” workflow, SSH protocol repository access needs to be set up first. Once an account has been created on a Git hosting site it should be possible to upload a public SSH key for repository access authentication. The “pull request” workflow will usually involve two remote repositories. In the real-life example below, the “origin” repository was forked from the “upstream” repository by using the Git hosting site's web interface. The [got.conf(5)](/got.conf/5.md) file in the local repository describes both remote repositories: ``` # Jelmers's repository, which accepts pull requests remote "upstream" { server git@github.com protocol ssh repository "/jelmer/dulwich" branch { "master" } } # Stefan's fork, used as the default remote repository remote "origin" { server git@github.com protocol ssh repository "/stspdotname/dulwich" branch { "master" } } ``` With this configuration, Stefan can create commits on “refs/heads/master” and send them to the “origin” repository by running: ``` $ got send -b master origin ``` The changes can now be proposed to Jelmer by opening a pull request via the Git hosting site's web interface. If Jelmer requests further changes to be made, additional commits can be created on the “master” branch and be added to the pull request by running **got** **send** again. If Jelmer prefers additional commits to be “squashed” then the following commands can be used to achieve this: ``` $ got update -b master ``` ``` $ got update -c origin/master ``` ``` $ got histedit -f ``` ``` $ got send -f -b master origin ``` In addition to reviewing the pull request in the web user interface, Jelmer can fetch the pull request's branch into his local repository and create a local branch which contains the proposed changes: ``` $ got fetch -R refs/pull/1046/head origin ``` ``` $ got branch -c refs/remotes/origin/pull/1046/head pr1046 ``` Once Jelmer has accepted the pull request, Stefan can fetch the merged changes, and possibly several other new changes, by running: ``` $ got fetch upstream ``` The merged changes will now be visible under the reference “refs/remotes/upstream/master”. The local “master” branch can now be rebased on top of the latest changes from upstream: ``` $ got update -b upstream/master ``` ``` $ got rebase master ``` As an alternative to **got** **rebase**, branches can be merged with **got** **merge**: ``` $ got update -b master ``` ``` $ got merge upstream/master ``` The question of whether to rebase or merge branches is philosophical. When in doubt, refer to the software project's policies set by project maintainers. As a final step, the forked repository's copy of the master branch needs to be kept in sync by sending the new changes there: ``` $ got send -f -b master origin ``` If multiple pull requests need to be managed in parallel, a separate branch must be created for each pull request with **got** **branch**. Each such branch can then be used as above, in place of “refs/heads/master”. Changes for any accepted pull requests will still appear under “refs/remotes/upstream/master,” regardless of which branch was used in the forked repository to create a pull request. ## SEE ALSO [gotadmin(1)](/gotadmin/1.md), [tog(1)](/tog/1.md), [git-repository(5)](/git-repository/5.md), [got-worktree(5)](/got-worktree/5.md), [got.conf(5)](/got.conf/5.md), gotwebd(8) ## AUTHORS Anthony J. Bentley ⟨*bentley@openbsd.org*⟩ Christian Weisgerber ⟨*naddy@openbsd.org*⟩ Florian Obser ⟨*florian@narrans.de*⟩ Hiltjo Posthuma ⟨*hiltjo@codemadness.org*⟩ James Cook ⟨*falsifian@falsifian.org*⟩ Jasper Lievisse Adriaanse ⟨*j@jasper.la*⟩ Josh Rickmar ⟨*jrick@zettaport.com*⟩ Joshua Stein ⟨*jcs@openbsd.org*⟩ Josiah Frentsos ⟨*jfrent@tilde.team*⟩ Klemens Nanni ⟨*kn@openbsd.org*⟩ Kyle Ackerman ⟨*kackerman0102@gmail.com*⟩ Lorenz (xha) ⟨*me@xha.li*⟩ Lucas Gabriel Vuotto ⟨*lucas@sexy.is*⟩ Mark Jamsek ⟨*mark@jamsek.dev*⟩ Martin Pieuchot ⟨*mpi@openbsd.org*⟩ Mikhail Pchelin ⟨*misha@freebsd.org*⟩ Neels Hofmeyr ⟨*neels@hofmeyr.de*⟩ Omar Polo ⟨*op@openbsd.org*⟩ Ori Bernstein ⟨*ori@openbsd.org*⟩ Sebastien Marie ⟨*semarie@openbsd.org*⟩ Stefan Sperling ⟨*stsp@openbsd.org*⟩ Steven McDonald ⟨*steven@steven-mcdonald.id.au*⟩ Ted Unangst ⟨*tedu@tedunangst.com*⟩ Theo Buehler ⟨*tb@openbsd.org*⟩ Thomas Adam ⟨*thomas@xteddy.org*⟩ Tobias Heider ⟨*me@tobhe.de*⟩ Tom Jones ⟨*thj@freebsd.org*⟩ Tracey Emery ⟨*tracey@traceyemery.net*⟩ Yang Zhong ⟨*yzhong@freebsdfoundation.org*⟩ Parts of **got**, [tog(1)](/tog/1.md), [gotd(8)](/gotd/8.md), and gotwebd(8) were derived from code under copyright by: Bjoern Hoehrmann Caldera International Daniel Hartmeier David Gwynne Esben Norby Florian Obser Henning Brauer Håkan Olsson Ingo Schwarze Jean-Francois Brousseau Jerome Kasper Joris Vink Jyri J. Virkki Larry Wall Markus Friedl Mike Larkin Niall O'Higgins Niklas Hallqvist Ray Lai Reyk Floeter Ryan McBride Ted Unangst Theo de Raadt Todd C. Miller Xavier Santolaria **got** contains code contributed to the public domain by Austin Appleby. ## CAVEATS **got** is a work-in-progress and some features remain to be implemented. At present, the user has to fall back on [git(1)](/git/1.md) to perform some tasks. In particular: - With repositories that use the sha256 object ID hashing algorithm, [git(1)](/git/1.md) is currently required for all network operations (clone, fetch, and push) because **got** does not yet support version 2 of the Git network protocol. - Writing to remote repositories over HTTP or HTTPS protocols requires [git-push(1)](/git-push/1.md). - The creation of merge commits with more than two parent commits requires [git-merge(1)](/git-merge/1.md). - In situations where files or directories were moved around **got** will not automatically merge changes to new locations and [git(1)](/git/1.md) will usually produce better results.