Dictionaries/git.ps1
|
$version = [Version][Regex]::Match((git --version), 'git version (\d+.\d+.\d+)').Groups[1].Value $cleanupMode = [StaticSource]@{ Name = "cleanup mode"; Description = "Determines how the supplied commit messaged should be cleaned up before committing"; Items = @( [SourceItem]@{ Name = "strip"; Description = "Strip leading and trailing empty lines, trailing whitepace, commentary and collapse consecutive empty lines" }, [SourceItem]@{ Name = "whitespace"; Description = "Same as strip except #commentary is not removed" }, [SourceItem]@{ Name = "verbatim"; Description = "Do not change the message at all" }, [SourceItem]@{ Name = "scissors"; Description = "Same as whitespace except that everything from (and including) the line found below is truncated" }, [SourceItem]@{ Name = "default"; Description = "Same as strip if the message is to be edited. Otherwise whitespace" } ) } $executionBit = [StaticSource]@{ Name = "executable bit"; Description = "Allow the execution of file"; Items = @( [SourceItem]@{ Name = "+x"; Description = "Allow execution" }, [SourceItem]@{ Name = "-x"; Description = "Deny execution" } ) } $allBranches = [DynamicSource]@{ Name = "AllBranches"; Description = "Local and remote branches"; CommandExpression = { git --no-optional-locks branch -a --no-color | % { $_.trim(' *$(') } | % { $_.StartsWith("remotes/origin/") ? $_.Substring(15) : $_ } | Where-Object { !$_.StartsWith("HEAD") } | Select -Unique }; Cache = [Cache]@{ ByCurrentWorkingDirectory = $true; ByTime = New-TimeSpan -Seconds 10 } } $localBranches = [DynamicSource]@{ Name = "LocalBranches"; Description = "Local branches"; CommandExpression = { git --no-optional-locks branch --no-color | % { $_.trim(' *$(') } | % { $_.StartsWith("remotes/origin/") ? $_.Substring(15) : $_ } | Where-Object { !$_.StartsWith("HEAD") } | Select -Unique }; Cache = [Cache]@{ ByCurrentWorkingDirectory = $true; ByTime = New-TimeSpan -Seconds 10 } } $stashes = [DynamicSource]@{ Name = "Stashes"; Description = "Stashes"; CommandExpression = { git --no-optional-locks stash list -a --no-color | Select -Unique }; Cache = [Cache]@{ ByCurrentWorkingDirectory = $true; ByTime = New-TimeSpan -Seconds 10 } } # Should we remove the Parameter part? CommandParameter -> Command? [PowerTypeDictionary]@{ Keys = @("git"); Name = "git"; Description = "fast, scalable, distributed revision control system"; Platforms = [Platforms]::All; State = [DictionaryState]::Generated -bor [DictionaryState]::Experimental -bor [DictionaryState]::Incomplete; Source = "Generated from manual with some manual fine tuning"; Url = "https://git-scm.com/"; Version = [Version]::Parse("2.34.1"); Parameters = @( [CommandParameter]@{ Keys = @("add"); Name = "add"; Description = "Add file contents to the index"; Parameters = @( [FlagParameter]@{ Keys = @("--dry-run", "-n"); Name = "dry-run"; Description = "Don’t actually add the file(s), just show if they exist and/or will be ignored."; }, [FlagParameter]@{ Keys = @("--verbose", "-v"); Name = "verbose"; Description = "Be verbose."; }, [FlagParameter]@{ Keys = @("--force", "-f"); Name = "force"; Description = "Allow adding otherwise ignored files."; }, [FlagParameter]@{ Keys = @("--sparse"); Name = "sparse"; Description = "Allow updating index entries outside of the sparse-checkout cone. Normally, git add refuses to update index entries whose paths do not fit within the sparse-checkout cone, since those files might be removed from the working tree without warning. See git-sparse-checkout1 for more details."; Condition = [LargerOrEqualCondition]::new($version, [Version]'2.34.0') }, [FlagParameter]@{ Keys = @("--interactive", "-i"); Name = "interactive"; Description = "Add modified contents in the working tree interactively to the index. Optional path arguments may be supplied to limit operation to a subset of the working tree. See `“Interactive mode`” for details."; }, [FlagParameter]@{ Keys = @("--patch", "-p"); Name = "patch"; Description = "Interactively choose hunks of patch between the index and the work tree and add them to the index. This gives the user a chance to review the difference before adding modified contents to the index."; }, [FlagParameter]@{ Keys = @("--edit", "-e"); Name = "edit"; Description = "Open the diff vs. the index in an editor and let the user edit it. After the editor was closed, adjust the hunk headers and apply the patch to the index."; }, [FlagParameter]@{ Keys = @("--update", "-u"); Name = "update"; Description = "Update the index just where it already has an entry matching <pathspec>. This removes as well as modifies index entries to match the working tree, but adds no new files."; }, [FlagParameter]@{ Keys = @("--all", "-A", "--no-ignore-removal"); Name = "no-ignore-removal"; Description = "Update the index not only where the working tree has a file matching <pathspec> but also where the index already has an entry. This adds, modifies, and removes index entries to match the working tree."; Condition = [ExclusiveParameterCondition]::new("ignore-removal") }, [FlagParameter]@{ Keys = @("--ignore-removal", "--no-all"); Name = "ignore-removal"; Description = "Update the index by adding new files that are unknown to the index and files modified in the working tree, but ignore files that have been removed from the working tree. This option is a no-op when no <pathspec> is used."; Condition = [ExclusiveParameterCondition]::new("no-ignore-removal") }, [FlagParameter]@{ Keys = @("--intent-to-add", "-N"); Name = "intent-to-add"; Description = "Record only the fact that the path will be added later. An entry for the path is placed in the index with no content. This is useful for, among other things, showing the unstaged content of such files with git diff and committing them with git commit -a."; }, [FlagParameter]@{ Keys = @("--refresh"); Name = "refresh"; Description = "Don’t add the file(s), but only refresh their stat() information in the index."; }, [FlagParameter]@{ Keys = @("--ignore-errors"); Name = "ignore-errors"; Description = "If some files could not be added because of errors indexing them, do not abort the operation, but continue adding the others. The command shall still exit with non-zero status. The configuration variable add.ignoreErrors can be set to true to make this the default behaviour."; }, [FlagParameter]@{ Keys = @("--ignore-missing"); Name = "ignore-missing"; Description = "This option can only be used together with --dry-run. By using this option the user can check if any of the given files would be ignored, no matter if they are already present in the work tree or not."; }, [FlagParameter]@{ Keys = @("--no-warn-embedded-repo"); Name = "no-warn-embedded-repo"; Description = "By default, git add will warn when adding an embedded repository to the index without using git submodule add to create an entry in .gitmodules. This option will suppress the warning (e.g., if you are manually performing operations on submodules)."; }, [FlagParameter]@{ Keys = @("--renormalize"); Name = "renormalize"; Description = "Apply the `"clean`" process freshly to all tracked files to forcibly add them again to the index. This is useful after changing core.autocrlf configuration or the text attribute in order to correct files added with wrong CRLF/LF line endings. This option implies -u."; }, [ValueParameter]@{ Keys = @("--chmod"); Name = "chmod"; Description = "Override the executable bit of the added files. The executable bit is only changed in the index, the files on disk are left unchanged."; Source = $executionBit }, [ValueParameter]@{ Keys = @("--pathspec-from-file"); Name = "pathspec-from-file"; Description = "Pathspec is passed in <file> instead of commandline args. If <file> is exactly - then standard input is used. Pathspec elements are separated by LF or CR/LF. Pathspec elements can be quoted as explained for the configuration variable core.quotePath (see git-config1 ). See also --pathspec-file-nul and global --literal-pathspecs."; #Source = File; }, [FlagParameter]@{ Keys = @("--pathspec-file-nul"); Name = "pathspec-file-nul"; Description = "Only meaningful with --pathspec-from-file. Pathspec elements are separated with NUL character and all other characters are taken literally (including newlines and quotes)."; }, [FlagParameter]@{ Keys = @("--"); Name = "seperator"; Description = "This option can be used to separate command-line options from the list of files, (useful when filenames might be mistaken for command-line options)."; }, [ValueParameter]@{ Name = "pathspec"; Description = "Files to add content from. Fileglobs (e.g. *.c) can be given to add all matching files. Also a leading directory name (e.g. dir to add dir/file1 and dir/file2) can be given to update the index to match the current state of the directory as a whole (e.g. specifying dir will record not just a file dir/file1 modified in the working tree, a file dir/file2 added to the working tree, but also a file dir/file3 removed from the working tree). Note that older versions of Git used to ignore removed files; use --no-all option if you want to add modified or new files but ignore removed ones."; #Source = FileGlob Or File Or Directory } ) }, [CommandParameter]@{ Keys = @("commit"); Name = "commit"; Description = "Record changes to the repository"; Parameters = @( [ValueParameter]@{ Keys = @("--message", "-m"); Name = "message"; Description = "Use the given <msg> as the commit message. If multiple -m options are given, their values are concatenated as separate paragraphs."; }, [FlagParameter]@{ Keys = @("--all", "-a"); Name = "all"; Description = "Tell the command to automatically stage files that have been modified and deleted, but new files you have not told Git about are not affected."; }, [FlagParameter]@{ Keys = @("--patch", "-p"); Name = "patch"; Description = "Use the interactive patch selection interface to choose which changes to commit. See git-add1 for details."; }, [ValueParameter]@{ Keys = @("--reuse-message", "-C"); Name = "reuse-message"; Description = "Take an existing commit object, and reuse the log message and the authorship information (including the timestamp) when creating the commit."; }, [ValueParameter]@{ Keys = @("--reedit-message", "-c"); Name = "reedit-message"; Description = "Like -C, but with -c the editor is invoked, so that the user can further edit the commit message."; }, [ValueParameter]@{ Keys = @("--fixup"); Name = "fixup"; Description = "Create a new commit which `"fixes up`" <commit> when applied with git rebase --autosquash. Plain --fixup=<commit> creates a `"fixup!`" commit which changes the content of <commit> but leaves its log message untouched. --fixup=amend:<commit> is similar but creates an `"amend!`" commit which also replaces the log message of <commit> with the log message of the `"amend!`" commit. --fixup=reword:<commit> creates an `"amend!`" commit which replaces the log message of <commit> with its own log message but makes no changes to the content of <commit>."; Source = [StaticSource]@{ Name = "fixup mode"; Description = ""; Items = @( [SourceItem]@{ Name = ""; Description = "creates a commit which changes the content of the commit but leaves its log message untouched." }, [SourceItem]@{ Name = "amend:"; Description = "is similar but creates an amend commit which also replaces the log message of the commit with the log message of the amend commit." }, [SourceItem]@{ Name = "reword:"; Description = "creates an amend commit which replaces the log message of the commit with its own log message but makes no changes to the content of the commit" } ) } }, [ValueParameter]@{ Keys = @("--squash"); Name = "squash"; Description = "Construct a commit message for use with rebase --autosquash. The commit message subject line is taken from the specified commit with a prefix of `"squash! `". Can be used with additional commit message options (-m/-c/-C/-F). See git-rebase1 for details."; }, [FlagParameter]@{ Keys = @("--reset-author"); Name = "reset-author"; Description = "When used with -C/-c/--amend options, or when committing after a conflicting cherry-pick, declare that the authorship of the resulting commit now belongs to the committer. This also renews the author timestamp."; }, [FlagParameter]@{ Keys = @("--short"); Name = "short"; Description = "When doing a dry-run, give the output in the short-format. See git-status1 for details. Implies --dry-run."; }, [FlagParameter]@{ Keys = @("--branch"); Name = "branch"; Description = "Show the branch and tracking info even in short-format."; }, [FlagParameter]@{ Keys = @("--porcelain"); Name = "porcelain"; Description = "When doing a dry-run, give the output in a porcelain-ready format. See git-status1 for details. Implies --dry-run."; }, [FlagParameter]@{ Keys = @("--long"); Name = "long"; Description = "When doing a dry-run, give the output in the long-format. Implies --dry-run."; }, [FlagParameter]@{ Keys = @("--null", "-z"); Name = "null"; Description = "When showing short or porcelain status output, print the filename verbatim and terminate the entries with NUL, instead of LF. If no format is given, implies the --porcelain output format. Without the -z option, filenames with `"unusual`" characters are quoted as explained for the configuration variable core.quotePath (see git-config1 )."; }, [ValueParameter]@{ Keys = @("--file", "-F"); Name = "file"; Description = "Take the commit message from the given file. Use - to read the message from the standard input."; #Source = File; }, [ValueParameter]@{ Keys = @("--author"); Name = "author"; Description = "Override the commit author. Specify an explicit author using the standard A U Thor <author@example.com> format. Otherwise <author> is assumed to be a pattern and is used to search for an existing commit by that author (i.e. rev-list --all -i --author=<author>); the commit author is then copied from the first such commit found."; }, [ValueParameter]@{ Keys = @("--date"); Name = "date"; Description = "Override the author date used in the commit."; }, [ValueParameter]@{ Keys = @("--template", "-t"); Name = "template"; Description = "When editing the commit message, start the editor with the contents in the given file. The commit.template configuration variable is often used to give this option implicitly to the command. This mechanism can be used by projects that want to guide participants with some hints on what to write in the message in what order. If the user exits the editor without editing the message, the commit is aborted. This has no effect when a message is given by other means, e.g. with the -m or -F options."; #Source = File; }, [FlagParameter]@{ Keys = @("--signoff", "--no-signoff", "-s"); Name = "no-signoff"; Description = "Add a Signed-off-by trailer by the committer at the end of the commit log message. The meaning of a signoff depends on the project to which you’re committing. For example, it may certify that the committer has the rights to submit the work under the project’s license or agrees to some contributor representation, such as a Developer Certificate of Origin. (See http://developercertificate.org for the one used by the Linux kernel and Git projects.) Consult the documentation or leadership of the project to which you’re contributing to understand how the signoffs are used in that project."; }, [ValueParameter]@{ Keys = @("--trailer"); Name = "trailer"; Description = "Specify a (<token>, <value>) pair that should be applied as a trailer. (e.g. git commit --trailer `"Signed-off-by:C O Mitter \ <committer@example.com>`" --trailer `"Helped-by:C O Mitter \ <committer@example.com>`" will add the `"Signed-off-by`" trailer and the `"Helped-by`" trailer to the commit message.) The trailer.* configuration variables ( git-interpret-trailers1 ) can be used to define if a duplicated trailer is omitted, where in the run of trailers each trailer would appear, and other details."; Condition = [LargerOrEqualCondition]::new($version, [Version]'2.32.0') }, [FlagParameter]@{ Keys = @("--verify"); Name = "verify"; Description = "By default, the pre-commit and commit-msg hooks are run. When any of --no-verify or -n is given, these are bypassed. See also githooks."; Condition = [ExclusiveParameterCondition]::new("no verify") }, [FlagParameter]@{ Keys = @("--no-verify", "-n"); Name = "no verify"; Description = "By default, the pre-commit and commit-msg hooks are run. When any of --no-verify or -n is given, these are bypassed. See also githooks."; Condition = [ExclusiveParameterCondition]::new("verify") }, [FlagParameter]@{ Keys = @("--allow-empty"); Name = "allow-empty"; Description = "Usually recording a commit that has the exact same tree as its sole parent commit is a mistake, and the command prevents you from making such a commit. This option bypasses the safety, and is primarily for use by foreign SCM interface scripts."; }, [FlagParameter]@{ Keys = @("--allow-empty-message"); Name = "allow-empty-message"; Description = "Like --allow-empty this command is primarily for use by foreign SCM interface scripts. It allows you to create a commit with an empty commit message without using plumbing commands like git-commit-tree1 ."; }, [ValueParameter]@{ Keys = @("--cleanup"); Name = "cleanup"; Description = "This option determines how the supplied commit message should be cleaned up before committing. The <mode> can be strip, whitespace, verbatim, scissors or default."; Source = $cleanupMode; }, [FlagParameter]@{ Keys = @("--edit", "-e"); Name = "edit"; Description = "The message taken from file with -F, command line with -m, and from commit object with -C are usually used as the commit log message unmodified. This option lets you further edit the message taken from these sources."; Condition = [ExclusiveParameterCondition]::new("no-edit") }, [FlagParameter]@{ Keys = @("--no-edit"); Name = "no-edit"; Description = "Use the selected commit message without launching an editor. For example, git commit --amend --no-edit amends a commit without changing its commit message."; Condition = [ExclusiveParameterCondition]::new("edit") }, [FlagParameter]@{ Keys = @("--amend"); Name = "amend"; Description = "Replace the tip of the current branch by creating a new commit. The recorded tree is prepared as usual (including the effect of the -i and -o options and explicit pathspec), and the message from the original commit is used as the starting point, instead of an empty message, when no other message is specified from the command line via options such as -m, -F, -c, etc. The new commit has the same parents and author as the current one (the --reset-author option can countermand this)."; }, [FlagParameter]@{ Keys = @("--no-post-rewrite"); Name = "no-post-rewrite"; Description = "Bypass the post-rewrite hook."; }, [FlagParameter]@{ Keys = @("--include", "-i"); Name = "include"; Description = "Before making a commit out of staged contents so far, stage the contents of paths given on the command line as well. This is usually not what you want unless you are concluding a conflicted merge."; }, [FlagParameter]@{ Keys = @("--only", "-o"); Name = "only"; Description = "Make a commit by taking the updated working tree contents of the paths specified on the command line, disregarding any contents that have been staged for other paths. This is the default mode of operation of git commit if any paths are given on the command line, in which case this option can be omitted. If this option is specified together with --amend, then no paths need to be specified, which can be used to amend the last commit without committing changes that have already been staged. If used together with --allow-empty paths are also not required, and an empty commit will be created."; }, [ValueParameter]@{ Keys = @("--pathspec-from-file"); Name = "pathspec-from-file"; Description = "Pathspec is passed in <file> instead of commandline args. If <file> is exactly - then standard input is used. Pathspec elements are separated by LF or CR/LF. Pathspec elements can be quoted as explained for the configuration variable core.quotePath (see git-config1 ). See also --pathspec-file-nul and global --literal-pathspecs."; #Source = File; }, [FlagParameter]@{ Keys = @("--pathspec-file-nul"); Name = "pathspec-file-nul"; Description = "Only meaningful with --pathspec-from-file. Pathspec elements are separated with NUL character and all other characters are taken literally (including newlines and quotes)."; }, [ValueParameter]@{ Keys = @("--untracked-files", "-u"); Name = "untracked-files"; Description = "Show untracked files."; Source = [StaticSource]@{ Name = "Untracked files handeling"; Items = @( [SourceItem]@{ Name = "no"; Description = "Show no untracked files" }, [SourceItem]@{ Name = "normal"; Description = "Shows untracked files and directories" }, [SourceItem]@{ Name = "all"; Description = "Also shows individual files in untracked directories." } ) } }, [FlagParameter]@{ Keys = @("--verbose", "-v"); Name = "verbose"; Description = "Show unified diff between the HEAD commit and what would be committed at the bottom of the commit message template to help the user describe the commit by reminding what changes the commit has. Note that this diff output doesn’t have its lines prefixed with #. This diff will not be a part of the commit message. See the commit.verbose configuration variable in git-config1 ."; Condition = [ExclusiveParameterCondition]::new("quiet") }, [FlagParameter]@{ Keys = @("--quiet", "-q"); Name = "quiet"; Description = "Suppress commit summary message."; Condition = [ExclusiveParameterCondition]::new("verbose") }, [FlagParameter]@{ Keys = @("--dry-run"); Name = "dry-run"; Description = "Do not create a commit, but show a list of paths that are to be committed, paths with local changes that will be left uncommitted and paths that are untracked."; }, [FlagParameter]@{ Keys = @("--status"); Name = "status"; Description = "Include the output of git-status1 in the commit message template when using an editor to prepare the commit message. Defaults to on, but can be used to override configuration variable commit.status."; Condition = [ExclusiveParameterCondition]::new("no-status") }, [FlagParameter]@{ Keys = @("--no-status"); Name = "no-status"; Description = "Do not include the output of git-status1 in the commit message template when using an editor to prepare the default commit message."; Condition = [ExclusiveParameterCondition]::new("status") }, [ValueParameter]@{ Keys = @("--gpg-sign", "-S"); Name = "gpg-sign"; Description = "GPG-sign commits. The keyid argument is optional and defaults to the committer identity; if specified, it must be stuck to the option without a space. --no-gpg-sign is useful to countermand both commit.gpgSign configuration variable, and earlier --gpg-sign."; Condition = [ExclusiveParameterCondition]::new("no-gpg-sign") }, [FlagParameter]@{ Keys = @("--no-gpg-sign"); Name = "no-gpg-sign"; Description = "Don't gpg sign"; Condition = [ExclusiveParameterCondition]::new("gpg-sign") }, [FlagParameter]@{ Keys = @("--"); Name = "Seperator"; Description = "Do not interpret any more arguments as options."; }, [ValueParameter]@{ Name = "pathspec"; Description = "When pathspec is given on the command line, commit the contents of the files that match the pathspec without recording the changes already added to the index. The contents of these files are also staged for the next commit on top of what have been staged before."; #Source = Not 100% sure but file glob? } ) }, [CommandParameter]@{ Keys = @("checkout"); Name = "checkout"; Description = "Switch branches or restore working tree files"; Parameters = @( [ValueParameter]@{ Name = "Branch to checkout or new_branch or start_point or tree-ish"; Description = "Branch to checkout; if it refers to a branch (i.e., a name that, when prepended with `"refs/heads/`", is a valid ref), then that branch is checked out. Otherwise, if it refers to a valid commit, your HEAD becomes `"detached`" and you are no longer on any branch (see below for details)."; Source = $allBranches }, [FlagParameter]@{ Keys = @("--quiet", "-q"); Name = "quiet"; Description = "Quiet, suppress feedback messages."; }, [FlagParameter]@{ Keys = @("--progress", "--no-progress"); Name = "progress"; Description = "Progress status is reported on the standard error stream by default when it is attached to a terminal, unless --quiet is specified. This flag enables progress reporting even if not attached to a terminal, regardless of --quiet."; }, [FlagParameter]@{ Keys = @("--force", "-f"); Name = "force"; Description = "When switching branches, proceed even if the index or the working tree differs from HEAD, and even if there are untracked files in the way. This is used to throw away local changes and any untracked files or directories that are in the way."; }, [FlagParameter]@{ Keys = @("--ours", "--theirs"); Name = "ours"; Description = "When checking out paths from the index, check out stage #2 (ours) or #3 (theirs) for unmerged paths."; }, [FlagParameter]@{ Keys = @("-b"); Name = "Create new branch"; Description = "Create a new branch named <new_branch> and start it at <start_point>; see git-branch1 for details."; #Condition = Not contains -B }, [FlagParameter]@{ Keys = @("-B"); Name = "Create new or reset branch"; Description = "Creates the branch <new_branch> and start it at <start_point>; if it already exists, then reset it to <start_point>. This is equivalent to running `"git branch`" with `"-f`"; see git-branch1 for details."; #Condition = Not contains -b }, [FlagParameter]@{ Keys = @("--track", "-t"); Name = "track"; Description = "When creating a new branch, set up `"upstream`" configuration. See `"--track`" in git-branch1 for details."; Condition = [ExclusiveParameterCondition]::new("no-track") }, [FlagParameter]@{ Keys = @("--no-track"); Name = "no-track"; Description = "Do not set up `"upstream`" configuration, even if the branch.autoSetupMerge configuration variable is true."; Condition = [ExclusiveParameterCondition]::new("track") }, [FlagParameter]@{ Keys = @("--guess"); Name = "guess"; Description = "If <branch> is not found but there does exist a tracking branch in exactly one remote (call it <remote>) with a matching name, treat as equivalent to"; Condition = [ExclusiveParameterCondition]::new("no-guess") }, [FlagParameter]@{ Keys = @("--no-guess"); Name = "no-guess"; Description = "If <branch> is not found but there does exist a tracking branch in exactly one remote (call it <remote>) with a matching name, treat as equivalent to"; Condition = [ExclusiveParameterCondition]::new("guess") }, [FlagParameter]@{ Keys = @("-l"); Name = "new branch"; Description = "Create the new branch’s reflog; see git-branch1 for details."; }, [FlagParameter]@{ Keys = @("--detach", "-d"); Name = "detach"; Description = "Rather than checking out a branch to work on it, check out a commit for inspection and discardable experiments. This is the default behavior of git checkout <commit> when <commit> is not a branch name. See the `"DETACHED HEAD`" section below for details."; }, [ValueParameter]@{ Keys = @("--orphan"); Name = "orphan"; Description = "Create a new orphan branch, named <new_branch>, started from <start_point> and switch to it. The first commit made on this new branch will have no parents and it will be the root of a new history totally disconnected from all the other branches and commits."; }, [FlagParameter]@{ Keys = @("--ignore-skip-worktree-bits"); Name = "ignore-skip-worktree-bits"; Description = "In sparse checkout mode, git checkout -- <paths> would update only entries matched by <paths> and sparse patterns in $GIT_DIR/info/sparse-checkout. This option ignores the sparse patterns and adds back any files in <paths>."; }, [FlagParameter]@{ Keys = @("--merge", "-m"); Name = "merge"; Description = "When switching branches, if you have local modifications to one or more files that are different between the current branch and the branch to which you are switching, the command refuses to switch branches in order to preserve your modifications in context. However, with this option, a three-way merge between the current branch, your working tree contents, and the new branch is done, and you will be on the new branch."; }, [ValueParameter]@{ Keys = @("--conflict"); Name = "conflict"; Description = "The same as --merge option above, but changes the way the conflicting hunks are presented, overriding the merge.conflictStyle configuration variable. Possible values are `"merge`" (default) and `"diff3`" (in addition to what is shown by `"merge`" style, shows the original contents)."; Source = [StaticSource]@{ Name = "Conflict hunks presentation mode"; Items = @( [SourceItem]@{ Name = "merge" }, [SourceItem]@{ Name = "diff3" } ) } }, [FlagParameter]@{ Keys = @("--patch", "-p"); Name = "patch"; Description = "Interactively select hunks in the difference between the <tree-ish> (or the index, if unspecified) and the working tree. The chosen hunks are then applied in reverse to the working tree (and if a <tree-ish> was specified, the index)."; }, [FlagParameter]@{ Keys = @("--ignore-other-worktrees"); Name = "ignore-other-worktrees"; Description = "git checkout refuses when the wanted ref is already checked out by another worktree. This option makes it check the ref out anyway. In other words, the ref can be held by more than one worktree."; }, [FlagParameter]@{ Keys = @("--overwrite-ignore", "--no-overwrite-ignore"); Name = "overwrite-ignore"; Description = "Silently overwrite ignored files when switching branches. This is the default behavior. Use --no-overwrite-ignore to abort the operation when the new branch contains ignored files."; }, [FlagParameter]@{ Keys = @("--recurse-submodules", "--no-recurse-submodules"); Name = "recurse-submodules"; Description = "Using --recurse-submodules will update the content of all active submodules according to the commit recorded in the superproject. If local modifications in a submodule would be overwritten the checkout will fail unless -f is used. If nothing (or --no-recurse-submodules) is used, submodules working trees will not be updated. Just like git-submodule1 , this will detach HEAD of the submodule."; }, [FlagParameter]@{ Keys = @("--overlay"); Name = "overlay"; Description = "In the default overlay mode, git checkout never removes files from the index or the working tree. When specifying --no-overlay, files that appear in the index and working tree, but not in <tree-ish> are removed, to make them match <tree-ish> exactly."; Condition = [ExclusiveParameterCondition]::new("no-overlay") }, [FlagParameter]@{ Keys = @("--no-overlay"); Name = "no-overlay"; Description = "In the default overlay mode, git checkout never removes files from the index or the working tree. When specifying --no-overlay, files that appear in the index and working tree, but not in <tree-ish> are removed, to make them match <tree-ish> exactly."; Condition = [ExclusiveParameterCondition]::new("overlay") }, [ValueParameter]@{ Keys = @("--pathspec-from-file"); Name = "pathspec-from-file"; Description = "Pathspec is passed in <file> instead of commandline args. If <file> is exactly - then standard input is used. Pathspec elements are separated by LF or CR/LF. Pathspec elements can be quoted as explained for the configuration variable core.quotePath (see git-config1 ). See also --pathspec-file-nul and global --literal-pathspecs."; #Source = File; }, [FlagParameter]@{ Keys = @("--pathspec-file-nul"); Name = "pathspec-file-nul"; Description = "Only meaningful with --pathspec-from-file. Pathspec elements are separated with NUL character and all other characters are taken literally (including newlines and quotes)."; }, [FlagParameter]@{ Keys = @("--"); Name = "Seperator"; Description = "Do not interpret any more arguments as options."; }, [ValueParameter]@{ Name = "pathspec"; Description = "Limits the paths affected by the operation."; #Source = Not 100% sure file glob? } ) }, [CommandParameter]@{ Keys = @("stash"); Name = "stash"; Description = "Stash the changes in a dirty working directory away"; Parameters = @( [CommandParameter]@{ Keys = @("list"); Name = "list"; Parameters = @() }, [CommandParameter]@{ Keys = @("show"); Name = "show"; Parameters = @( [FlagParameter]@{ Keys = @("--include-untracked", "-u"); Name = "include-untracked"; Description = "All untracked files are also stashed and then cleaned up with git clean."; Condition = [ExclusiveParameterCondition]::new("no-include-untracked") }, [FlagParameter]@{ Keys = @("--no-include-untracked"); Name = "no-include-untracked"; Description = "No untracked files are stashed and then cleaned up with git clean."; Condition = [ExclusiveParameterCondition]::new("include-untracked") }, [ValueParameter]@{ Name = "stash"; Source = $stashes } ) }, [CommandParameter]@{ Keys = @("drop"); Name = "drop"; Parameters = @( [FlagParameter]@{ Keys = @("--quiet", "-q"); Name = "quiet"; }, [ValueParameter]@{ Name = "stash"; Source = $stashes } ) }, [CommandParameter]@{ Keys = @("pop", "apply"); Name = "pop"; Parameters = @( [FlagParameter]@{ Keys = @("--index"); Name = "index"; }, [FlagParameter]@{ Keys = @("--quiet", "-q"); Name = "quiet"; }, [ValueParameter]@{ Name = "stash"; Source = $stashes } ) }, [CommandParameter]@{ Keys = @("branch"); Name = "branch"; Parameters = @( [ValueParameter]@{ Name = "branch"; Source = $allBranches }, [ValueParameter]@{ Name = "stash"; Source = $stashes } ) }, [CommandParameter]@{ Keys = @("push"); Name = "push"; Parameters = @( [FlagParameter]@{ Keys = @("--patch", "-p"); Name = "patch"; }, [FlagParameter]@{ Keys = @("--keep-index", "-k"); Name = "keep-index"; Description = "All changes already added to the index are left intact."; Condition = [ExclusiveParameterCondition]::new("no-keep-index") }, [FlagParameter]@{ Keys = @("--no-keep-index"); Name = "no-keep-index"; Condition = [ExclusiveParameterCondition]::new("keep-index") }, [FlagParameter]@{ Keys = @("--include-untracked", "-u"); Name = "include-untracked"; Description = "All untracked files are also stashed and then cleaned up with git clean."; Condition = [ExclusiveParameterCondition]::new("no-include-untracked") }, [FlagParameter]@{ Keys = @("--no-include-untracked"); Name = "no-include-untracked"; Description = "No untracked files are stashed and then cleaned up with git clean."; Condition = [ExclusiveParameterCondition]::new("include-untracked") }, [FlagParameter]@{ Keys = @("--all", "-a"); Name = "all"; }, [FlagParameter]@{ Keys = @("--quiet", "-q"); Name = "quiet"; }, [ValueParameter]@{ Keys = @("--message", "-m"); Name = "message"; }, [ValueParameter]@{ Keys = @("--pathspec-from-file"); Name = "pathspec-from-file"; # Source = #File glob?; } ) }, [CommandParameter]@{ Keys = @("clear"); Name = "clear"; Parameters = @() }, [CommandParameter]@{ Keys = @("create"); Name = "create"; Parameters = @( [ValueParameter]@{ Name = "message"; } ) }, [CommandParameter]@{ Keys = @("store"); Name = "store"; Parameters = @( [ValueParameter]@{ Keys = @("--message", "-m"); Name = "message"; }, [FlagParameter]@{ Keys = @("--quiet", "-q"); Name = "quiet"; }, [ValueParameter]@{ Name = "commit"; } ) } ) }, [CommandParameter]@{ Keys = @("merge"); Name = "merge"; Description = "Join two or more development histories together"; Parameters = @( [ValueParameter]@{ Name = "local-branch"; Source = $localBranches }, [FlagParameter]@{ Keys = @("--commit"); Name = "commit"; Description = "Perform the merge and commit the result. This option can be used to override --no-commit."; Condition = [ExclusiveParameterCondition]::new("no-commit") }, [FlagParameter]@{ Keys = @("--no-commit"); Name = "no-commit"; Condition = [ExclusiveParameterCondition]::new("commit") }, [FlagParameter]@{ Keys = @("--edit", "-e"); Name = "edit"; Description = "Invoke an editor before committing successful mechanical merge to further edit the auto-generated merge message, so that the user can explain and justify the merge. The --no-edit option can be used to accept the auto-generated message (this is generally discouraged). The --edit (or -e) option is still useful if you are giving a draft message with the -m option from the command line and want to edit it in the editor."; Condition = [ExclusiveParameterCondition]::new("no-edit") }, [FlagParameter]@{ Keys = @("--no-edit"); Name = "no-edit"; Description = "Invoke an editor before committing successful mechanical merge to further edit the auto-generated merge message, so that the user can explain and justify the merge. The --no-edit option can be used to accept the auto-generated message (this is generally discouraged). The --edit (or -e) option is still useful if you are giving a draft message with the -m option from the command line and want to edit it in the editor."; Condition = [ExclusiveParameterCondition]::new("edit") }, [ValueParameter]@{ Keys = @("--cleanup"); Name = "cleanup"; Description = "This option determines how the merge message will be cleaned up before committing. See git-commit1 for more details. In addition, if the <mode> is given a value of scissors, scissors will be appended to MERGE_MSG before being passed on to the commit machinery in the case of a merge conflict."; Source = $cleanupMode }, [FlagParameter]@{ Keys = @("--ff", "--no-ff", "--ff-only"); Name = "ff-only"; Description = "Specifies how a merge is handled when the merged-in history is already a descendant of the current history. --ff is the default unless merging an annotated (and possibly signed) tag that is not stored in its natural place in the refs/tags/ hierarchy, in which case --no-ff is assumed."; }, [ValueParameter]@{ Keys = @("--gpg-sign", "-S"); Name = "gpg-sign"; Description = "GPG-sign the resulting merge commit. The keyid argument is optional and defaults to the committer identity; if specified, it must be stuck to the option without a space. --no-gpg-sign is useful to countermand both commit.gpgSign configuration variable, and earlier --gpg-sign."; Condition = [ExclusiveParameterCondition]::new("no-pg-sign") }, [FlagParameter]@{ Keys = @("--no-gpg-sign"); Name = "no-gpg-sign"; Condition = [ExclusiveParameterCondition]::new("pg-sign") }, [ValueParameter]@{ Keys = @("--log"); Name = "log"; Description = "In addition to branch names, populate the log message with one-line descriptions from at most <n> actual commits that are being merged. See also git-fmt-merge-msg1."; Condition = [ExclusiveParameterCondition]::new("no-log") }, [FlagParameter]@{ Keys = @("--no-log"); Name = "no-log"; Condition = [ExclusiveParameterCondition]::new("log") }, [FlagParameter]@{ Keys = @("--signoff"); Name = "signoff"; Description = "Add a Signed-off-by trailer by the committer at the end of the commit log message. The meaning of a signoff depends on the project to which you’re committing. For example, it may certify that the committer has the rights to submit the work under the project’s license or agrees to some contributor representation, such as a Developer Certificate of Origin. (See http://developercertificate.org for the one used by the Linux kernel and Git projects.) Consult the documentation or leadership of the project to which you’re contributing to understand how the signoffs are used in that project."; Condition = [ExclusiveParameterCondition]::new("no-signoff") }, [FlagParameter]@{ Keys = @("--no-signoff"); Name = "no-signoff"; Condition = [ExclusiveParameterCondition]::new("signoff") }, [FlagParameter]@{ Keys = @("--stat"); Name = "stat"; Description = "Show a diffstat at the end of the merge. The diffstat is also controlled by the configuration option merge.stat."; Condition = [ExclusiveParameterCondition]::new("no-stat") }, [FlagParameter]@{ Keys = @("--no-stat", "-n"); Name = "no-stat"; Condition = [ExclusiveParameterCondition]::new("stat") }, [FlagParameter]@{ Keys = @("--squash"); Name = "squash"; Description = 'Produce the working tree and index state as if a real merge happened (except for the merge information), but do not actually make a commit, move the HEAD, or record $GIT_DIR/MERGE_HEAD (to cause the next git commit command to create a merge commit). This allows you to create a single commit on top of the current branch whose effect is the same as merging another branch (or more in case of an octopus).'; Condition = [ExclusiveParameterCondition]::new("no-squash") }, [FlagParameter]@{ Keys = @("--no-squash"); Name = "no-squash"; Condition = [ExclusiveParameterCondition]::new("squash") }, [FlagParameter]@{ Keys = @("--verify"); Name = "verify"; Description = "By default, the pre-merge and commit-msg hooks are run. When --no-verify is given, these are bypassed. See also githooks5 ."; Condition = [ExclusiveParameterCondition]::new("no-verify") }, [FlagParameter]@{ Keys = @("--no-verify"); Name = "no-verify"; Description = "By default, the pre-merge and commit-msg hooks are run. When --no-verify is given, these are bypassed. See also githooks5 ."; Condition = [ExclusiveParameterCondition]::new("verify") }, [ValueParameter]@{ Keys = @("--strategy", "-s"); Name = "strategy"; Description = "Use the given merge strategy; can be supplied more than once to specify them in the order they should be tried. If there is no -s option, a built-in list of strategies is used instead (ort when merging a single head, octopus otherwise)."; Source = [StaticSource]@{ Name = "Merge strategy"; Items = @( [SourceItem]@{ Name = "ort" }, [SourceItem]@{ Name = "recursive" }, [SourceItem]@{ Name = "resolve" }, [SourceItem]@{ Name = "octopus" }, [SourceItem]@{ Name = "ours" }, [SourceItem]@{ Name = "theirs" }, [SourceItem]@{ Name = "subtree" } ) }; }, [ValueParameter]@{ Keys = @("--strategy-option", "-X"); Name = "strategy-option"; Description = "Pass merge strategy specific option through to the merge strategy."; Condition = [NotCondition]::new([ExclusiveParameterCondition]::new("strategy")) # Only display this if strategy was used # Source = $???; # todo: Implement this later }, [FlagParameter]@{ Keys = @("--verify-signatures"); Name = "verify-signatures"; Description = "Verify that the tip commit of the side branch being merged is signed with a valid key, i.e. a key that has a valid uid: in the default trust model, this means the signing key has been signed by a trusted key. If the tip commit of the side branch is not signed with a valid key, the merge is aborted."; Condition = [ExclusiveParameterCondition]::new("no-verify-signatures") }, [FlagParameter]@{ Keys = @("--no-verify-signatures"); Name = "no-verify-signatures"; Description = "Verify that the tip commit of the side branch being merged is signed with a valid key, i.e. a key that has a valid uid: in the default trust model, this means the signing key has been signed by a trusted key. If the tip commit of the side branch is not signed with a valid key, the merge is aborted."; Condition = [ExclusiveParameterCondition]::new("verify-signatures") }, [FlagParameter]@{ Keys = @("--quiet", "-q"); Name = "quiet"; Description = "Operate quietly. Implies --no-progress."; }, [FlagParameter]@{ Keys = @("--verbose", "-v"); Name = "verbose"; Description = "Be verbose."; }, [FlagParameter]@{ Keys = @("--progress"); Name = "progress"; Description = "Turn progress on/off explicitly. If neither is specified, progress is shown if standard error is connected to a terminal. Note that not all merge strategies may support progress reporting."; Condition = [ExclusiveParameterCondition]::new("progress") }, [FlagParameter]@{ Keys = @("--no-progress"); Name = "no-progress"; Description = "Turn progress on/off explicitly. If neither is specified, progress is shown if standard error is connected to a terminal. Note that not all merge strategies may support progress reporting."; Condition = [ExclusiveParameterCondition]::new("no-progress") }, [FlagParameter]@{ Keys = @("--autostash"); Name = "autostash"; Description = "Automatically create a temporary stash entry before the operation begins, record it in the special ref MERGE_AUTOSTASH and apply it after the operation ends. This means that you can run the operation on a dirty worktree. However, use with care: the final stash application after a successful merge might result in non-trivial conflicts."; Condition = [ExclusiveParameterCondition]::new("no-autostash") }, [FlagParameter]@{ Keys = @("--no-autostash"); Name = "no-autostash"; Condition = [ExclusiveParameterCondition]::new("autostash") }, [FlagParameter]@{ Keys = @("--allow-unrelated-histories"); Name = "allow-unrelated-histories"; Description = "By default, git merge command refuses to merge histories that do not share a common ancestor. This option can be used to override this safety when merging histories of two projects that started their lives independently. As that is a very rare occasion, no configuration variable to enable this by default exists and will not be added."; }, [ValueParameter]@{ Keys = @("-m"); Name = "message"; Description = "Set the commit message to be used for the merge commit (in case one is created)."; }, [ValueParameter]@{ Keys = @("--file", "-F"); Name = "file"; Description = "Read the commit message to be used for the merge commit (in case one is created)."; #Source = File; }, [FlagParameter]@{ Keys = @("--rerere-autoupdate"); Name = "rerere-autoupdate"; Description = "Allow the rerere mechanism to update the index with the result of auto-conflict resolution if possible."; Condition = [ExclusiveParameterCondition]::new("no-rerere-autoupdate") }, [FlagParameter]@{ Keys = @("--no-rerere-autoupdate"); Name = "no-rerere-autoupdate"; Condition = [ExclusiveParameterCondition]::new("rerere-autoupdate") }, [FlagParameter]@{ Keys = @("--overwrite-ignore"); Name = "overwrite-ignore"; Description = "Silently overwrite ignored files from the merge result. This is the default behavior. Use --no-overwrite-ignore to abort."; Condition = [ExclusiveParameterCondition]::new("no-overwrite-ignore") }, [FlagParameter]@{ Keys = @("--no-overwrite-ignore"); Name = "no-overwrite-ignore"; Condition = [ExclusiveParameterCondition]::new("overwrite-ignore") }, [FlagParameter]@{ Keys = @("--abort"); Name = "abort"; Description = "Abort the current conflict resolution process, and try to reconstruct the pre-merge state. If an autostash entry is present, apply it to the worktree."; }, [FlagParameter]@{ Keys = @("--quit"); Name = "quit"; Description = "Forget about the current merge in progress. Leave the index and the working tree as-is. If MERGE_AUTOSTASH is present, the stash entry will be saved to the stash list."; }, [FlagParameter]@{ Keys = @("--continue"); Name = "continue"; Description = "After a git merge stops due to conflicts you can conclude the merge by running git merge --continue (see `"HOW TO RESOLVE CONFLICTS`" section below)."; }, [ValueParameter]@{ Name = "commit hash"; Description = "Commits, usually other branch heads, to merge into our branch. Specifying more than one commit will create a merge with more than two parents (affectionately called an Octopus merge)."; } ) }, [CommandParameter]@{ Keys = @("clone"); Name = "clone"; Description = "Clone a repository into a new directory"; Parameters = @( [FlagParameter]@{ Keys = @("--local", "-l"); Name = "local"; Description = "When the repository to clone from is on a local machine, this flag bypasses the normal `"Git aware`" transport mechanism and clones the repository by making a copy of HEAD and everything under objects and refs directories. The files under .git/objects/ directory are hardlinked to save space when possible."; }, [FlagParameter]@{ Keys = @("--no-hardlinks"); Name = "no-hardlinks"; Description = "Force the cloning process from a repository on a local filesystem to copy the files under the .git/objects directory instead of using hardlinks. This may be desirable if you are trying to make a back-up of your repository."; }, [FlagParameter]@{ Keys = @("--shared", "-s"); Name = "shared"; Description = "When the repository to clone is on the local machine, instead of using hard links, automatically setup .git/objects/info/alternates to share the objects with the source repository. The resulting repository starts out without any object of its own."; }, [ValueParameter]@{ Keys = @("--reference", "--reference-if-able"); Name = "reference"; Description = "If the reference repository is on the local machine, automatically setup .git/objects/info/alternates to obtain objects from the reference repository. Using an already existing repository as an alternate will require fewer objects to be copied from the repository being cloned, reducing network and local storage costs. When using the --reference-if-able, a non existing directory is skipped with a warning instead of aborting the clone."; }, [FlagParameter]@{ Keys = @("--dissociate"); Name = "dissociate"; Description = "Borrow the objects from reference repositories specified with the --reference options only to reduce network transfer, and stop borrowing from them after a clone is made by making necessary local copies of borrowed objects. This option can also be used when cloning locally from a repository that already borrows objects from another repository—the new repository will borrow objects from the same repository, and this option can be used to stop the borrowing."; }, [FlagParameter]@{ Keys = @("--quiet", "-q"); Name = "quiet"; Description = "Operate quietly. Progress is not reported to the standard error stream."; Condition = [ExclusiveParameterCondition]::new("verbose"); }, [FlagParameter]@{ Keys = @("--verbose", "-v"); Name = "verbose"; Description = "Run verbosely. Does not affect the reporting of progress status to the standard error stream."; Condition = [ExclusiveParameterCondition]::new("quiet"); }, [FlagParameter]@{ Keys = @("--progress"); Name = "progress"; Description = "Progress status is reported on the standard error stream by default when it is attached to a terminal, unless --quiet is specified. This flag forces progress status even if the standard error stream is not directed to a terminal."; }, [ValueParameter]@{ Keys = @("--server-option"); Name = "server-option"; Description = "Transmit the given string to the server when communicating using protocol version 2. The given string must not contain a NUL or LF character. The server’s handling of server options, including unknown ones, is server-specific. When multiple --server-option=<option> are given, they are all sent to the other side in the order listed on the command line."; }, [FlagParameter]@{ Keys = @("--no-checkout", "-n"); Name = "no-checkout"; Description = "No checkout of HEAD is performed after the clone is complete."; }, [FlagParameter]@{ Keys = @("--reject-shallow"); Name = "reject-shallow"; Description = "Fail if the source repository is a shallow repository. The clone.rejectShallow configuration variable can be used to specify the default."; Condition = [ExclusiveParameterCondition]::new("no-reject-shallow") }, [FlagParameter]@{ Keys = @("--no-reject-shallow"); Name = "no-reject-shallow"; Description = "Fail if the source repository is a shallow repository. The clone.rejectShallow configuration variable can be used to specify the default."; Condition = [ExclusiveParameterCondition]::new("reject-shallow") }, [FlagParameter]@{ Keys = @("--bare"); Name = "bare"; Description = "Make a bare Git repository. That is, instead of creating <directory> and placing the administrative files in <directory>/.git, make the <directory> itself the $GIT_DIR. This obviously implies the --no-checkout because there is nowhere to check out the working tree. Also the branch heads at the remote are copied directly to corresponding local branch heads, without mapping them to refs/remotes/origin/. When this option is used, neither remote-tracking branches nor the related configuration variables are created."; }, [FlagParameter]@{ Keys = @("--sparse"); Name = "sparse"; Description = "Initialize the sparse-checkout file so the working directory starts with only the files in the root of the repository. The sparse-checkout file can be modified to grow the working directory as needed."; }, [ValueParameter]@{ Keys = @("--filter"); Name = "filter"; Description = "Use the partial clone feature and request that the server sends a subset of reachable objects according to a given object filter. When using --filter, the supplied <filter-spec> is used for the partial clone filter. For example, --filter=blob:none will filter out all blobs (file contents) until needed by Git. Also, --filter=blob:limit=<size> will filter out all blobs of size at least <size>. For more details on filter specifications, see the --filter option in git-rev-list1 ."; }, [FlagParameter]@{ Keys = @("--mirror"); Name = "mirror"; Description = "Set up a mirror of the source repository. This implies --bare. Compared to --bare, --mirror not only maps local branches of the source to local branches of the target, it maps all refs (including remote-tracking branches, notes etc.) and sets up a refspec configuration such that all these refs are overwritten by a git remote update in the target repository."; }, [ValueParameter]@{ Keys = @("--origin", "-o"); Name = "origin"; Description = "Instead of using the remote name origin to keep track of the upstream repository, use <name>. Overrides clone.defaultRemoteName from the config."; }, [ValueParameter]@{ Keys = @("--branch", "-b"); Name = "branch"; Description = "Instead of pointing the newly created HEAD to the branch pointed to by the cloned repository’s HEAD, point to <name> branch instead. In a non-bare repository, this is the branch that will be checked out. --branch can also take tags and detaches the HEAD at that commit in the resulting repository."; }, [ValueParameter]@{ Keys = @("--upload-pack", "-u"); Name = "upload-pack"; Description = "When given, and the repository to clone from is accessed via ssh, this specifies a non-default path for the command run on the other end."; }, [ValueParameter]@{ Keys = @("--template"); Name = "template"; Description = "Specify the directory from which templates will be used; (See the `"TEMPLATE DIRECTORY`" section of git-init1 .)"; # Source = Directory; }, #todo we dont know how to handle --config key=value #[ValueParameter]@{ # Keys = @("--config <key>", "-c <key>"); # Name = "config <key>"; # Description = "Set a configuration variable in the newly-created repository; this takes effect immediately after the repository is initialized, but before the remote history is fetched or any files checked out. The key is in the same format as expected by git-config1 (e.g., core.eol=true). If multiple values are given for the same key, each value will be written to the config file. This makes it safe, for example, to add additional fetch refspecs to the origin remote."; # Source = $???; #}, [ValueParameter]@{ Keys = @("--depth"); Name = "depth"; Description = "Create a shallow clone with a history truncated to the specified number of commits. Implies --single-branch unless --no-single-branch is given to fetch the histories near the tips of all branches. If you want to clone submodules shallowly, also pass --shallow-submodules."; }, [ValueParameter]@{ Keys = @("--shallow-since"); Name = "shallow-since"; Description = "Create a shallow clone with a history after the specified time."; }, [ValueParameter]@{ Keys = @("--shallow-exclude"); Name = "shallow-exclude"; Description = "Create a shallow clone with a history, excluding commits reachable from a specified remote branch or tag. This option can be specified multiple times."; }, [FlagParameter]@{ Keys = @("--single-branch"); Name = "single-branch"; Description = "Clone only the history leading to the tip of a single branch, either specified by the --branch option or the primary branch remote’s HEAD points at. Further fetches into the resulting repository will only update the remote-tracking branch for the branch this option was used for the initial cloning. If the HEAD at the remote did not point at any branch when --single-branch clone was made, no remote-tracking branch is created."; Condition = [ExclusiveParameterCondition]::new("no-single-branch"); }, [FlagParameter]@{ Keys = @("--no-single-branch"); Name = "no-single-branch"; Description = "Clone only the history leading to the tip of a single branch, either specified by the --branch option or the primary branch remote’s HEAD points at. Further fetches into the resulting repository will only update the remote-tracking branch for the branch this option was used for the initial cloning. If the HEAD at the remote did not point at any branch when --single-branch clone was made, no remote-tracking branch is created."; Condition = [ExclusiveParameterCondition]::new("single-branch"); }, [FlagParameter]@{ Keys = @("--no-tags"); Name = "no-tags"; Description = "Don’t clone any tags, and set remote.<remote>.tagOpt=--no-tags in the config, ensuring that future git pull and git fetch operations won’t follow any tags. Subsequent explicit tag fetches will still work, (see git-fetch1 )."; }, [ValueParameter]@{ Keys = @("--recurse-submodules"); Name = "recurse-submodules"; Description = "After the clone is created, initialize and clone submodules within based on the provided pathspec. If no pathspec is provided, all submodules are initialized and cloned. This option can be given multiple times for pathspecs consisting of multiple entries. The resulting clone has submodule.active set to the provided pathspec, or `".`" (meaning all submodules) if no pathspec is provided."; }, [FlagParameter]@{ Keys = @("--shallow-submodules"); Name = "shallow-submodules"; Description = "All submodules which are cloned will be shallow with a depth of 1."; Condition = [ExclusiveParameterCondition]::new("no-shallow-submodules"); }, [FlagParameter]@{ Keys = @("--no-shallow-submodules"); Name = "no-shallow-submodules"; Description = "All submodules which are cloned will be shallow with a depth of 1."; Condition = [ExclusiveParameterCondition]::new("shallow-submodules"); }, [FlagParameter]@{ Keys = @("--remote-submodules"); Name = "remote-submodules"; Description = "All submodules which are cloned will use the status of the submodule’s remote-tracking branch to update the submodule, rather than the superproject’s recorded SHA-1. Equivalent to passing --remote to git submodule update."; Condition = [ExclusiveParameterCondition]::new("no-remote-submodules"); }, [FlagParameter]@{ Keys = @("--no-remote-submodules"); Name = "no-remote-submodules"; Description = "All submodules which are cloned will use the status of the submodule’s remote-tracking branch to update the submodule, rather than the superproject’s recorded SHA-1. Equivalent to passing --remote to git submodule update."; Condition = [ExclusiveParameterCondition]::new("remote-submodules"); }, [ValueParameter]@{ Keys = @("--separate-git-dir"); Name = "separate-git-dir"; Description = "Instead of placing the cloned repository where it is supposed to be, place the cloned repository at the specified directory, then make a filesystem-agnostic Git symbolic link to there. The result is Git repository can be separated from working tree."; # Source = Directory; }, [ValueParameter]@{ Keys = @("--jobs", "-j"); Name = "jobs"; Description = "The number of submodules fetched at the same time. Defaults to the submodule.fetchJobs option."; }, [ValueParameter]@{ Keys = @("repository"); Name = "repository"; Description = "The (possibly remote) repository to clone from. See the GIT URLS section below for more information on specifying repositories."; }, [ValueParameter]@{ Keys = @("directory"); Name = "directory"; Description = "The name of a new directory to clone into. The `"humanish`" part of the source repository is used if no directory is explicitly given (repo for /path/to/repo.git and foo for host.xz:foo/.git). Cloning into an existing directory is only allowed if the directory is empty."; # Source = Directory } ) }, [CommandParameter]@{ Keys = @("rebase"); Name = "rebase"; Description = "Reapply commits on top of another base tip"; Parameters = @( [ValueParameter]@{ Keys = @("--onto"); Name = "onto"; Description = "Starting point at which to create the new commits. If the --onto option is not specified, the starting point is <upstream>. May be any valid commit, and not just an existing branch name."; }, [FlagParameter]@{ Keys = @("--keep-base"); Name = "keep-base"; Description = "Set the starting point at which to create the new commits to the merge base of <upstream> <branch>. Running git rebase --keep-base <upstream> <branch> is equivalent to running git rebase --onto <upstream>… <upstream>."; }, [ValueParameter]@{ Keys = @("upstream"); Name = "upstream"; Description = "Upstream branch to compare against. May be any valid commit, not just an existing branch name. Defaults to the configured upstream for the current branch."; }, [ValueParameter]@{ Keys = @("branch"); Name = "branch"; Description = "Working branch; defaults to HEAD."; Source = $allBranches }, [FlagParameter]@{ Keys = @("--continue"); Name = "continue"; Description = "Restart the rebasing process after having resolved a merge conflict."; }, [FlagParameter]@{ Keys = @("--abort"); Name = "abort"; Description = "Abort the rebase operation and reset HEAD to the original branch. If <branch> was provided when the rebase operation was started, then HEAD will be reset to <branch>. Otherwise HEAD will be reset to where it was when the rebase operation was started."; }, [FlagParameter]@{ Keys = @("--quit"); Name = "quit"; Description = "Abort the rebase operation but HEAD is not reset back to the original branch. The index and working tree are also left unchanged as a result. If a temporary stash entry was created using --autostash, it will be saved to the stash list."; }, [FlagParameter]@{ Keys = @("--apply"); Name = "apply"; Description = "Use applying strategies to rebase (calling git-am internally). This option may become a no-op in the future once the merge backend handles everything the apply one does."; }, [ValueParameter]@{ Keys = @("--empty"); Name = "empty"; Description = "How to handle commits that are not empty to start and are not clean cherry-picks of any upstream commit, but which become empty after rebasing (because they contain a subset of already upstream changes). With drop (the default), commits that become empty are dropped. With keep, such commits are kept. With ask (implied by --interactive), the rebase will halt when an empty commit is applied allowing you to choose whether to drop it, edit files more, or just commit the empty changes. Other options, like --exec, will use the default of drop unless -i/--interactive is explicitly specified."; Source = [StaticSource]@{ Name = "empty mode"; Description = ""; Items = @( [SourceItem]@{ Name = "drop"; Description = "commits that become empty are dropped" }, [SourceItem]@{ Name = "keep"; Description = "commits that become empty are kept" }, [SourceItem]@{ Name = "ask"; Description = "" } ) } }, [FlagParameter]@{ Keys = @("--keep-empty"); Name = "keep-empty"; Description = "Do not keep commits that start empty before the rebase (i.e. that do not change anything from its parent) in the result. The default is to keep commits which start empty, since creating such commits requires passing the --allow-empty override flag to git commit, signifying that a user is very intentionally creating such a commit and thus wants to keep it."; Condition = [ExclusiveParameterCondition]::new("no-keep-empty"); }, [FlagParameter]@{ Keys = @("--no-keep-empty"); Name = "no-keep-empty"; Description = "Do not keep commits that start empty before the rebase (i.e. that do not change anything from its parent) in the result. The default is to keep commits which start empty, since creating such commits requires passing the --allow-empty override flag to git commit, signifying that a user is very intentionally creating such a commit and thus wants to keep it."; Condition = [ExclusiveParameterCondition]::new("keep-empty"); }, [FlagParameter]@{ Keys = @("--reapply-cherry-picks"); Name = "reapply-cherry-picks"; Description = "Reapply all clean cherry-picks of any upstream commit instead of preemptively dropping them. (If these commits then become empty after rebasing, because they contain a subset of already upstream changes, the behavior towards them is controlled by the --empty flag.)"; Condition = [ExclusiveParameterCondition]::new("no-reapply-cherry-picks"); }, [FlagParameter]@{ Keys = @("--no-reapply-cherry-picks"); Name = "no-reapply-cherry-picks"; Description = "Reapply all clean cherry-picks of any upstream commit instead of preemptively dropping them. (If these commits then become empty after rebasing, because they contain a subset of already upstream changes, the behavior towards them is controlled by the --empty flag.)"; Condition = [ExclusiveParameterCondition]::new("reapply-cherry-picks"); }, [FlagParameter]@{ Keys = @("--allow-empty-message"); Name = "allow-empty-message"; Description = "No-op. Rebasing commits with an empty message used to fail and this option would override that behavior, allowing commits with empty messages to be rebased. Now commits with an empty message do not cause rebasing to halt."; }, [FlagParameter]@{ Keys = @("--skip"); Name = "skip"; Description = "Restart the rebasing process by skipping the current patch."; }, [FlagParameter]@{ Keys = @("--edit-todo"); Name = "edit-todo"; Description = "Edit the todo list during an interactive rebase."; }, [FlagParameter]@{ Keys = @("--show-current-patch"); Name = "show-current-patch"; Description = "Show the current patch in an interactive rebase or when rebase is stopped because of conflicts. This is the equivalent of git show REBASE_HEAD."; }, [FlagParameter]@{ Keys = @("--merge", "-m"); Name = "merge"; Description = "Using merging strategies to rebase (default)."; }, [ValueParameter]@{ Keys = @("--strategy", "-s"); Name = "strategy"; Description = "Use the given merge strategy, instead of the default ort. This implies --merge."; # Source = $???; }, [ValueParameter]@{ Keys = @("--strategy-option", "-X"); Name = "strategy-option"; Description = "Pass the <strategy-option> through to the merge strategy. This implies --merge and, if no strategy has been specified, -s ort. Note the reversal of ours and theirs as noted above for the -m option."; # Source = $???; Condition = [NotCondition]::new([ExclusiveParameterCondition]::new("strategy")); }, [FlagParameter]@{ Keys = @("--rerere-autoupdate"); Name = "rerere-autoupdate"; Description = "Allow the rerere mechanism to update the index with the result of auto-conflict resolution if possible."; Condition = [ExclusiveParameterCondition]::new("no-rerere-autoupdate"); }, [FlagParameter]@{ Keys = @("--no-rerere-autoupdate"); Name = "no-rerere-autoupdate"; Description = "Allow the rerere mechanism to update the index with the result of auto-conflict resolution if possible."; Condition = [ExclusiveParameterCondition]::new("rerere-autoupdate"); }, [ValueParameter]@{ Keys = @("--gpg-sign", "-S"); Name = "gpg-sign"; Description = "GPG-sign commits. The keyid argument is optional and defaults to the committer identity; if specified, it must be stuck to the option without a space. --no-gpg-sign is useful to countermand both commit.gpgSign configuration variable, and earlier --gpg-sign."; Condition = [ExclusiveParameterCondition]::new("no-gpg-sign"); }, [FlagParameter]@{ Keys = @("--no-gpg-sign"); Name = "no-gpg-sign"; Description = "GPG-sign commits. The keyid argument is optional and defaults to the committer identity; if specified, it must be stuck to the option without a space. --no-gpg-sign is useful to countermand both commit.gpgSign configuration variable, and earlier --gpg-sign."; Condition = [ExclusiveParameterCondition]::new("gpg-sign"); }, [FlagParameter]@{ Keys = @("--quiet", "-q"); Name = "quiet"; Description = "Be quiet. Implies --no-stat."; Condition = [ExclusiveParameterCondition]::new("verbose"); }, [FlagParameter]@{ Keys = @("--verbose", "-v"); Name = "verbose"; Description = "Be verbose. Implies --stat."; Condition = [ExclusiveParameterCondition]::new("quiet"); }, [FlagParameter]@{ Keys = @("--stat"); Name = "stat"; Description = "Show a diffstat of what changed upstream since the last rebase. The diffstat is also controlled by the configuration option rebase.stat."; Condition = [ExclusiveParameterCondition]::new("no-stat"); }, [FlagParameter]@{ Keys = @("--no-stat", "-n"); Name = "no-stat"; Description = "Do not show a diffstat as part of the rebase process."; Condition = [ExclusiveParameterCondition]::new("stat"); }, [FlagParameter]@{ Keys = @("--no-verify"); Name = "no-verify"; Description = "This option bypasses the pre-rebase hook. See also githooks5 ."; Condition = [ExclusiveParameterCondition]::new("verify"); }, [FlagParameter]@{ Keys = @("--verify"); Name = "verify"; Description = "Allows the pre-rebase hook to run, which is the default. This option can be used to override --no-verify. See also githooks5 ."; Condition = [ExclusiveParameterCondition]::new("no-verify"); }, [ValueParameter]@{ Keys = @("-C"); Name = "ensure lines"; Description = "Ensure at least <n> lines of surrounding context match before and after each change. When fewer lines of surrounding context exist they all must match. By default no context is ever ignored. Implies --apply."; }, [FlagParameter]@{ Keys = @("--no-ff", "--force-rebase", "-f"); Name = "force-rebase"; Description = "Individually replay all rebased commits instead of fast-forwarding over the unchanged ones. This ensures that the entire history of the rebased branch is composed of new commits."; }, [FlagParameter]@{ Keys = @("--fork-point"); Name = "fork-point"; Description = "Use reflog to find a better common ancestor between <upstream> and <branch> when calculating which commits have been introduced by <branch>."; Condition = [ExclusiveParameterCondition]::new("no-fork-point"); }, [FlagParameter]@{ Keys = @("--no-fork-point"); Name = "no-fork-point"; Description = "Use reflog to find a better common ancestor between <upstream> and <branch> when calculating which commits have been introduced by <branch>."; Condition = [ExclusiveParameterCondition]::new("fork-point"); }, [FlagParameter]@{ Keys = @("--ignore-whitespace"); Name = "ignore-whitespace"; Description = "Ignore whitespace differences when trying to reconcile differences. Currently, each backend implements an approximation of this behavior:"; }, [ValueParameter]@{ Keys = @("--whitespace"); Name = "whitespace"; Description = "This flag is passed to the git apply program (see git-apply1 ) that applies the patch. Implies --apply."; # Source = $???; }, [FlagParameter]@{ Keys = @("--committer-date-is-author-date"); Name = "committer-date-is-author-date"; Description = "Instead of using the current time as the committer date, use the author date of the commit being rebased as the committer date. This option implies --force-rebase."; }, [FlagParameter]@{ Keys = @("--reset-author-date", "--ignore-date"); Name = "reset-author-date"; Description = "Instead of using the author date of the original commit, use the current time as the author date of the rebased commit. This option implies --force-rebase."; }, [FlagParameter]@{ Keys = @("--signoff"); Name = "signoff"; Description = "Add a Signed-off-by trailer to all the rebased commits. Note that if --interactive is given then only commits marked to be picked, edited or reworded will have the trailer added."; }, [FlagParameter]@{ Keys = @("--interactive", "-i"); Name = "interactive"; Description = "Make a list of the commits which are about to be rebased. Let the user edit that list before rebasing. This mode can also be used to split commits (see SPLITTING COMMITS below)."; }, [ValueParameter]@{ Keys = @("--rebase-merges", "-r"); Name = "rebase-merges"; Description = "By default, a rebase will simply drop merge commits from the todo list, and put the rebased commits into a single, linear branch. With --rebase-merges, the rebase will instead try to preserve the branching structure within the commits that are to be rebased, by recreating the merge commits. Any resolved merge conflicts or manual amendments in these merge commits will have to be resolved/re-applied manually."; Source = [StaticSource]@{ Name = "rebase-merges mode"; Description = ""; Items = @( [SourceItem]@{ Name = "rebase-cousins"; Description = "" }, [SourceItem]@{ Name = "no-rebase-cousins"; Description = "" } ) } }, [ValueParameter]@{ Keys = @("--exec", "-x"); Name = "exec"; Description = "Append `"exec <cmd>`" after each line creating a commit in the final history. <cmd> will be interpreted as one or more shell commands. Any command that fails will interrupt the rebase, with exit code 1."; }, [FlagParameter]@{ Keys = @("--root"); Name = "root"; Description = "Rebase all commits reachable from <branch>, instead of limiting them with an <upstream>. This allows you to rebase the root commit(s) on a branch. When used with --onto, it will skip changes already contained in <newbase> (instead of <upstream>) whereas without --onto it will operate on every change."; }, [FlagParameter]@{ Keys = @("--autosquash"); Name = "autosquash"; Description = "When the commit log message begins with `"squash! …`" or `"fixup! …`" or `"amend! …`", and there is already a commit in the todo list that matches the same ..., automatically modify the todo list of rebase -i, so that the commit marked for squashing comes right after the commit to be modified, and change the action of the moved commit from pick to squash or fixup or fixup -C respectively. A commit matches the ... if the commit subject matches, or if the ... refers to the commit’s hash. As a fall-back, partial matches of the commit subject work, too. The recommended way to create fixup/amend/squash commits is by using the --fixup, --fixup=amend: or --fixup=reword: and --squash options respectively of git-commit1 ."; Condition = [ExclusiveParameterCondition]::new("no-autosquash"); }, [FlagParameter]@{ Keys = @("--no-autosquash"); Name = "no-autosquash"; Description = "When the commit log message begins with `"squash! …`" or `"fixup! …`" or `"amend! …`", and there is already a commit in the todo list that matches the same ..., automatically modify the todo list of rebase -i, so that the commit marked for squashing comes right after the commit to be modified, and change the action of the moved commit from pick to squash or fixup or fixup -C respectively. A commit matches the ... if the commit subject matches, or if the ... refers to the commit’s hash. As a fall-back, partial matches of the commit subject work, too. The recommended way to create fixup/amend/squash commits is by using the --fixup, --fixup=amend: or --fixup=reword: and --squash options respectively of git-commit1 ."; Condition = [ExclusiveParameterCondition]::new("autosquash"); }, [FlagParameter]@{ Keys = @("--autostash"); Name = "autostash"; Description = "Automatically create a temporary stash entry before the operation begins, and apply it after the operation ends. This means that you can run rebase on a dirty worktree. However, use with care: the final stash application after a successful rebase might result in non-trivial conflicts."; Condition = [ExclusiveParameterCondition]::new("autostash"); }, [FlagParameter]@{ Keys = @("--no-autostash"); Name = "no-autostash"; Description = "Automatically create a temporary stash entry before the operation begins, and apply it after the operation ends. This means that you can run rebase on a dirty worktree. However, use with care: the final stash application after a successful rebase might result in non-trivial conflicts."; Condition = [ExclusiveParameterCondition]::new("no-autostash"); }, [FlagParameter]@{ Keys = @("--reschedule-failed-exec"); Name = "reschedule-failed-exec"; Description = "Automatically reschedule exec commands that failed. This only makes sense in interactive mode (or when an --exec option was provided)."; Condition = [ExclusiveParameterCondition]::new("no-reschedule-failed-exec"); }, [FlagParameter]@{ Keys = @("--no-reschedule-failed-exec"); Name = "no-reschedule-failed-exec"; Description = "Automatically reschedule exec commands that failed. This only makes sense in interactive mode (or when an --exec option was provided)."; Condition = [ExclusiveParameterCondition]::new("reschedule-failed-exec"); } ) }, [CommandParameter]@{ Keys = @("status"); Name = "status"; Description = "Show the working tree status"; Parameters = @( [FlagParameter]@{ Keys = @("--short", "-s"); Name = "short"; Description = "Give the output in the short-format."; }, [FlagParameter]@{ Keys = @("--branch", "-b"); Name = "branch"; Description = "Show the branch and tracking info even in short-format."; }, [FlagParameter]@{ Keys = @("--show-stash"); Name = "show-stash"; Description = "Show the number of entries currently stashed away."; }, [ValueParameter]@{ Keys = @("--porcelain"); Name = "porcelain"; Description = "Give the output in an easy-to-parse format for scripts. This is similar to the short output, but will remain stable across Git versions and regardless of user configuration. See below for details."; }, [FlagParameter]@{ Keys = @("--long"); Name = "long"; Description = "Give the output in the long-format. This is the default."; }, [FlagParameter]@{ Keys = @("--verbose", "-v"); Name = "verbose"; Description = "In addition to the names of files that have been changed, also show the textual changes that are staged to be committed (i.e., like the output of git diff --cached). If -v is specified twice, then also show the changes in the working tree that have not yet been staged (i.e., like the output of git diff)."; }, [ValueParameter]@{ Keys = @("--untracked-files", "-u"); Name = "untracked-files"; Description = "Show untracked files."; Source = [StaticSource]@{ Name = "untracked-files mode"; Description = ""; Items = @( [SourceItem]@{ Name = "no"; Description = "Show no untracked files." }, [SourceItem]@{ Name = "normal"; Description = "Shows untracked files and directories" }, [SourceItem]@{ Name = "all"; Description = "Also shows individual files in untracked directories" } ) } }, [ValueParameter]@{ Keys = @("--ignore-submodules"); Name = "ignore-submodules"; Description = "Ignore changes to submodules when looking for changes. <when> can be either `"none`", `"untracked`", `"dirty`" or `"all`", which is the default. Using `"none`" will consider the submodule modified when it either contains untracked or modified files or its HEAD differs from the commit recorded in the superproject and can be used to override any settings of the ignore option in git-config1 or gitmodules5 . When `"untracked`" is used submodules are not considered dirty when they only contain untracked content (but they are still scanned for modified content). Using `"dirty`" ignores all changes to the work tree of submodules, only changes to the commits stored in the superproject are shown (this was the behavior before 1.7.0). Using `"all`" hides all changes to submodules (and suppresses the output of submodule summaries when the config option status.submoduleSummary is set)."; }, [ValueParameter]@{ Keys = @("--ignored"); Name = "ignored"; Description = "Show ignored files as well."; Source = [StaticSource]@{ Name = "ignored mode"; Description = ""; Items = @( [SourceItem]@{ Name = "traditional"; Description = "Shows ignored files and directories, unless --untracked-files=all is specified, in which case individual files in ignored directories are displayed." }, [SourceItem]@{ Name = "no"; Description = "Show no ignored files." }, [SourceItem]@{ Name = "matching"; Description = "Shows ignored files and directories matching an ignore pattern." } ) } }, [FlagParameter]@{ Keys = @("-z"); Name = "nul termination"; Description = "Terminate entries with NUL, instead of LF. This implies the --porcelain=v1 output format if no other format is given."; }, [ValueParameter]@{ Keys = @("--column"); Name = "column"; Description = "Display untracked files in columns. See configuration variable column.status for option syntax. --column and --no-column without options are equivalent to always and never respectively."; Condition = [ExclusiveParameterCondition]::new("no-column"); }, [FlagParameter]@{ Keys = @("--no-column"); Name = "no-column"; Description = "Display untracked files in columns. See configuration variable column.status for option syntax. --column and --no-column without options are equivalent to always and never respectively."; Condition = [ExclusiveParameterCondition]::new("column"); }, [FlagParameter]@{ Keys = @("--ahead-behind"); Name = "ahead-behind"; Description = "Display or do not display detailed ahead/behind counts for the branch relative to its upstream branch. Defaults to true."; Condition = [ExclusiveParameterCondition]::new("no-ahead-behind"); }, [FlagParameter]@{ Keys = @("--no-ahead-behind"); Name = "no-ahead-behind"; Description = "Display or do not display detailed ahead/behind counts for the branch relative to its upstream branch. Defaults to true."; Condition = [ExclusiveParameterCondition]::new("ahead-behind"); }, [FlagParameter]@{ Keys = @("--renames"); Name = "renames"; Description = "Turn on/off rename detection regardless of user configuration. See also git-diff1 --no-renames."; Condition = [ExclusiveParameterCondition]::new("no-renames"); }, [FlagParameter]@{ Keys = @("--no-renames"); Name = "no-renames"; Description = "Turn on/off rename detection regardless of user configuration. See also git-diff1 --no-renames."; Condition = [ExclusiveParameterCondition]::new("renames"); }, [ValueParameter]@{ Keys = @("--find-renames"); Name = "find-renames"; Description = "Turn on rename detection, optionally setting the similarity threshold. See also git-diff1 --find-renames."; }, [ValueParameter]@{ Name = "pathspec"; Description = "See the pathspec entry in gitglossary7 ."; # Source = FilePattern } ) }, [CommandParameter]@{ Keys = @("push"); Name = "push"; Description = "Update remote refs along with associated objects"; Parameters = @( [FlagParameter]@{ Keys = @("--all"); Name = "all"; Description = "Push all branches (i.e. refs under refs/heads/); cannot be used with other <refspec>."; }, [FlagParameter]@{ Keys = @("--prune"); Name = "prune"; Description = "Remove remote branches that don’t have a local counterpart. For example a remote branch tmp will be removed if a local branch with the same name doesn’t exist any more"; }, [FlagParameter]@{ Keys = @("--mirror"); Name = "mirror"; Description = "Instead of naming each ref to push, specifies that all refs under refs/ (which includes but is not limited to refs/heads/, refs/remotes/, and refs/tags/) "; }, [FlagParameter]@{ Keys = @("--dry-run", "-n"); Name = "dry-run"; Description = "Do everything except actually send the updates."; }, [FlagParameter]@{ Keys = @("--porcelain"); Name = "porcelain"; Description = "Produce machine-readable output. The output status line for each ref will be tab-separated and sent to stdout instead of stderr. The full symbolic names of the refs will be given."; }, [FlagParameter]@{ Keys = @("--delete", "-d"); Name = "delete"; Description = "All listed refs are deleted from the remote repository. This is the same as prefixing all refs with a colon."; }, [FlagParameter]@{ Keys = @("--tags"); Name = "tags"; Description = "All refs under refs/tags are pushed, in addition to refspecs explicitly listed on the command line."; }, [FlagParameter]@{ Keys = @("--follow-tags"); Name = "follow-tags"; Description = "Push all the refs that would be pushed without this option, and also push annotated tags in refs/tags that are missing from the remote but are pointing at commit-ish that are reachable from the refs being pushed."; }, [ValueParameter]@{ Keys = @("--signed"); Name = "signed"; Description = ""; Condition = [ExclusiveParameterCondition]::new("no-signed"); Source = [StaticSource]@{ Name = "signed mode"; Description = ""; Items = @( [SourceItem]@{ Name = "true"; Description = "" }, [SourceItem]@{ Name = "false"; Description = "" }, [SourceItem]@{ Name = "if-asked"; Description = "" } ) } }, [FlagParameter]@{ Keys = @("--no-signed"); Name = "no-signed"; Description = ""; Condition = [ExclusiveParameterCondition]::new("signed"); }, [FlagParameter]@{ Keys = @("--atomic"); Name = "atomic"; Description = "Use an atomic transaction on the remote side if available. Either all refs are updated, or on error, no refs are updated. If the server does not support atomic pushes the push will fail."; Condition = [ExclusiveParameterCondition]::new("no-atomic"); }, [FlagParameter]@{ Keys = @("--no-atomic"); Name = "no-atomic"; Description = "Use an atomic transaction on the remote side if available. Either all refs are updated, or on error, no refs are updated. If the server does not support atomic pushes the push will fail."; Condition = [ExclusiveParameterCondition]::new("atomic"); }, [ValueParameter]@{ Keys = @("--push-option", "-o"); Name = "push-option"; Description = "Transmit the given string to the server, which passes them to the pre-receive as well as the post-receive hook. The given string must not contain a NUL or LF character. When multiple --push-option=<option> are given, they are all sent to the other side in the order listed on the command line. When no --push-option=<option> is given from the command line, the values of configuration variable push.pushOption are used instead."; }, [ValueParameter]@{ Keys = @("--receive-pack", "--exec"); Name = "receive-pack"; Description = "Path to the git-receive-pack program on the remote end. Sometimes useful when pushing to a remote repository over ssh, and you do not have the program in a directory on the default $PATH."; }, [ValueParameter]@{ Keys = @("--force-with-lease"); Name = "force-with-lease"; Description = "Usually, `"git push`" refuses to update a remote ref that is not an ancestor of the local ref used to overwrite it."; Condition = [ExclusiveParameterCondition]::new("no-force-with-lease"); }, [FlagParameter]@{ Keys = @("--no-force-with-lease"); Name = "no-force-with-lease"; Description = "Usually, `"git push`" refuses to update a remote ref that is not an ancestor of the local ref used to overwrite it."; Condition = [ExclusiveParameterCondition]::new("force-with-lease"); }, [FlagParameter]@{ Keys = @("--force", "-f"); Name = "force"; Description = "Usually, the command refuses to update a remote ref that is not an ancestor of the local ref used to overwrite it. Also, when --force-with-lease option is used, the command refuses to update a remote ref whose current value does not match what is expected."; }, [FlagParameter]@{ Keys = @("--force-if-includes"); Name = "force-if-includes"; Description = "Force an update only if the tip of the remote-tracking ref has been integrated locally."; Condition = [ExclusiveParameterCondition]::new("no-force-if-includes"); }, [FlagParameter]@{ Keys = @("--no-force-if-includes"); Name = "no-force-if-includes"; Description = "Force an update only if the tip of the remote-tracking ref has been integrated locally."; Condition = [ExclusiveParameterCondition]::new("force-if-includes"); }, [ValueParameter]@{ Keys = @("--repo"); Name = "repo"; Description = "This option is equivalent to the <repository> argument. If both are specified, the command-line argument takes precedence."; }, [ValueParameter]@{ Keys = @("--set-upstream", "-u"); Name = "set-upstream"; Description = "For every branch that is up to date or successfully pushed, add upstream (tracking) reference, used by argument-less git-pull[1] and other commands. For more information, see branch.<name>.merge in git-config[1]."; }, [FlagParameter]@{ Keys = @("--thin"); Name = "thin"; Description = "These options are passed to git-send-pack[1]. A thin transfer significantly reduces the amount of sent data when the sender and receiver share many of the same objects in common. The default is --thin."; Condition = [ExclusiveParameterCondition]::new("no-thin"); }, [FlagParameter]@{ Keys = @("no-thin"); Name = "no-thin"; Description = "These options are passed to git-send-pack[1]. A thin transfer significantly reduces the amount of sent data when the sender and receiver share many of the same objects in common. The default is --thin."; Condition = [ExclusiveParameterCondition]::new("thin"); }, [FlagParameter]@{ Keys = @("--verbose", "-v"); Name = "verbose"; Description = "Run verbosely."; Condition = [ExclusiveParameterCondition]::new("quiet") }, [FlagParameter]@{ Keys = @("--quiet", "-q"); Name = "quiet"; Description = "Suppress all output, including the listing of updated refs, unless an error occurs. Progress is not reported to the standard error stream."; Condition = [ExclusiveParameterCondition]::new("verbose") }, [FlagParameter]@{ Keys = @("--progress"); Name = "progress"; Description = "Progress status is reported on the standard error stream by default when it is attached to a terminal, unless -q is specified. This flag forces progress status even if the standard error stream is not directed to a terminal."; }, [ValueParameter]@{ Keys = @("--recurse-submodules"); Name = "recurse-submodules"; Description = "May be used to make sure all submodule commits used by the revisions to be pushed are available on a remote-tracking branch."; Condition = [ExclusiveParameterCondition]::new("no-recurse-submodules"); Source = [StaticSource]@{ Name = "recurse-submodules mode"; Description = ""; Items = @( [SourceItem]@{ Name = "check"; Description = "" }, [SourceItem]@{ Name = "on-demand"; Description = "" }, [SourceItem]@{ Name = "only"; Description = "" }, [SourceItem]@{ Name = "no"; Description = "" } ) } }, [FlagParameter]@{ Keys = @("--no-recurse-submodules"); Name = "no-recurse-submodules"; Description = "May be used to make sure all submodule commits used by the revisions to be pushed are available on a remote-tracking branch."; Condition = [ExclusiveParameterCondition]::new("recurse-submodules"); }, [FlagParameter]@{ Keys = @("--verify"); Name = "verify"; Description = "Toggle the pre-push hook (see githooks[5]). The default is --verify, giving the hook a chance to prevent the push. With --no-verify, the hook is bypassed completely."; Condition = [ExclusiveParameterCondition]::new("no-verify"); }, [FlagParameter]@{ Keys = @("--no-verify"); Name = "no-verify"; Description = "Toggle the pre-push hook (see githooks[5]). The default is --verify, giving the hook a chance to prevent the push. With --no-verify, the hook is bypassed completely."; Condition = [ExclusiveParameterCondition]::new("verify"); }, [FlagParameter]@{ Keys = @("--ipv4", "-4"); Name = "ipv4"; Description = "Use IPv4 addresses only, ignoring IPv6 addresses."; Condition = [ExclusiveParameterCondition]::new("ipv6"); }, [FlagParameter]@{ Keys = @("--ipv6", "-6"); Name = "ipv6"; Description = "Use IPv6 addresses only, ignoring IPv4 addresses."; Condition = [ExclusiveParameterCondition]::new("ipv4"); } [ValueParameter]@{ Name = "repository"; Description = "The `"remote`" repository that is destination of a push operation. This parameter can be either a URL (see the section GIT URLS below) or the name of a remote (see the section REMOTES below)."; } [ValueParameter]@{ Name = "refspec"; Description = "Specify what destination ref to update with what source object. The format of a <refspec> parameter is an optional plus +, followed by the source object <src>, followed by a colon :, followed by the destination ref <dst>."; } ) } ) } |