GitSharp.Git
Abstract command which can be invoked from the command line.
Commands are configured with a single "current" repository and then the
execute(String[]) method is invoked with the arguments that appear
after the subcommand.
Command constructors should perform as little work as possible as they may be
invoked very early during process loading, and the command may not execute
even though it was constructed.
Name of the command in use
Website address of the command help file
Specifies if the command requires a repository to execute
Specifies if the command requires an upward search for the git repository
RevWalk used during command line parsing, if it was required.
Contains the remaining arguments after the options listed in the command line.
Custom OptionSet to allow special option handling rules such as --option dir
Used by CommandCatalog and CommandRef to set the command name during initial creation.
The command name.
Used by CommandRef to get the command name during initial creation.
Used by CommandCatalog and CommandRef to set the website address of the command help during initial creation.
The website address of the command help.
Used by CommandRef to get the command help website during initial creation.
Initializes a command for use including the repository and output support.
Specifies the repository to use.
Parses the command line and runs the corresponding subcommand
Specifies the command line arguments passed after the command name.
Parses the options for all subcommands and executes the corresponding code for each option.
Specifies the string from the options to the end of the command line.
Returns the arguments remaining after the options on the command line. Often, these are directories or paths.
Parses the options for all subcommands and executes the corresponding code for each option. This function should only be used if supporting -- &filepatterns>
Specifies the string from the options to the end of the command line.
Returns a list of files following the -- argument
Returns the arguments remaining after the options on the command line. Often, these are directories or paths.
Returns the arguments remaining after the options on the command line. Often, these are directories or paths.
Returns the current command for lightweight referencing.
Returns this command.
Provides an abstract layer to perform the action of this command.
This method should only be invoked by the Execute(String[] args) method.
Opens the default webbrowser to display the command specific help.
Generic method used to return an exception during fatal conditions.
Specifies the textual explanation of why the exception was thrown.
Returns a runtime exception the caller is expected to throw.
Determine if the command requires a repository
Specifies if the command requires an upward search for the git repository
Internal Use Only. Used by NDesk.OptionSetTest for unit testing purposes of OptionSet.Parse.
Used to parse the options (aka arguments) denoted by a "-" or "--" in the command line and return the remaining arguments in a list.
The command line arguments.
Return value for the arguments remaining after parsing is complete.
Used to parse the options (aka arguments) denoted by a "-" or "--" in the command line.
This method also returns the multiple file references denoted by -- &filepattern> in git.
The command line arguments.
Return value for multiple file references, if specified. Setting the value to null will disable this option.
Return value for the arguments remaining after parsing is complete.
Annotation to document a {@link TextBuiltin}.
This is an optional annotation for TextBuiltin subclasses and it carries
documentation forward into the runtime system describing what the command is
and why users may want to invoke it.
List of all commands known by the command line tools.
Commands are implementations of the TextBuiltin class, with a required
command attribute to insert additional documentation and add some extra
information such as if the command is common and completed.
Commands may be registered by adding them to the Commands.xml file.
The Commands.xml file should contain:
a. The command name including namespace.
b. The website address for command specific online help.(optional)
Stores the command catalog.
Creates the command catalog from the Commands.xml file.
Returns all commands starting with a specified string, sorted by command name.
Create and loads the command name into the command catalog.
Specifies the command name to load.
Specifies the command's website for faster reference.
Locates a single command by its user friendly name.
Specifies the name of the command.
Returns the CommandRef containing the command's information.
Returns all known commands, sorted by command name.
Returns all common commands, sorted by command name.
Returns all incomplete commands, sorted by command name.
Returns all complete commands, sorted by command name.
Sorts a list of specified commands by command name.
Specifies the list of commands to be sorted.
Returns the sorted list of commands.
Description of a command subcommand.
These descriptions are lightweight compared to creating a command instance
and are therefore suitable for catalogs of "known" commands without linking
the command's implementation and creating a dummy instance of the command.
Returns the friendly command name. The command as invoked from the command line.
Returns a one line description of the command's feature set.
Returns true if this command is considered to be commonly used.
Returns true if this command is considered to be completed.
Returns true if this command requires a repository.
Returns the name of the class which implements this command.
Returns a new instance of the command implementation.
Indicates a implementation has failed during execution.
Typically the stack trace for a Die exception is not shown to the user as it
may indicate a simple error condition that the end-user can fix on their own,
without needing a screen of stack frames.
Construct a new message explaining what has gone wrong.
The message to show to the end-user.
Command line entry point.
Display the stack trace on exceptions
Load the parser options and
Execute the command line
Display the main offline help screen.
Implementation of --version
Display the incomplete commands in GitSharp. Primarily for development use.
Display the complete commands in GitSharp.
Display the commands that start with the specified string.
Returns true if matches exist, otherwise false.
Wait for Enter key if in DEBUG mode
Placeholder for the --git-dir command-line option. It is handled before it reaches this method.
Description of UnitTest.