https://github.com/brianm/git-like-cli
Git-like-cli is a Java annotation-based framework for parsing Git like command line structures.
https://github.com/brianm/git-like-cli
Last synced: 6 months ago
JSON representation
Git-like-cli is a Java annotation-based framework for parsing Git like command line structures.
- Host: GitHub
- URL: https://github.com/brianm/git-like-cli
- Owner: brianm
- License: apache-2.0
- Fork: true (dain/git-like-cli)
- Created: 2012-02-21T21:41:02.000Z (over 14 years ago)
- Default Branch: master
- Last Pushed: 2012-03-22T22:42:52.000Z (over 14 years ago)
- Last Synced: 2025-08-04T00:23:38.942Z (11 months ago)
- Language: Java
- Homepage:
- Size: 221 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: license.txt
Awesome Lists containing this project
README
Git-like-cli
============
Git-like-cli is a Java annotation-based framework for parsing Git like command line structures.
Here is a quick example:
```java
public class Git
{
public static void main(String[] args)
{
CliBuilder builder = buildCli("git", Runnable.class)
.withDescription("the stupid content tracker")
.withDefaultCommand(Help.class)
.withCommands(Help.class,
Add.class);
builder.withGroup("remote")
.withDescription("Manage set of tracked repositories")
.withDefaultCommand(RemoteShow.class)
.withCommands(RemoteShow.class,
RemoteAdd.class);
GitLikeCli gitParser = builder.build();
gitParser.parse(args).run();
}
public static class GitCommand implements Runnable
{
@Option(type = GLOBAL, name = "-v", description = "Verbose mode")
public boolean verbose;
public void run()
{
System.out.println(getClass().getSimpleName());
}
}
@Command(name = "add", description = "Add file contents to the index")
public static class Add extends GitCommand
{
@Arguments(description = "Patterns of files to be added")
public List patterns;
@Option(name = "-i", description = "Add modified contents interactively.")
public boolean interactive;
}
@Command(name = "show", description = "Gives some information about the remote ")
public static class RemoteShow extends GitCommand
{
@Option(name = "-n", description = "Do not query remote heads")
public boolean noQuery;
@Arguments(description = "Remote to show")
public String remote;
}
@Command(name = "add", description = "Adds a remote")
public static class RemoteAdd extends GitCommand
{
@Option(name = "-t", description = "Track only a specific branch")
public String branch;
@Arguments(description = "Remote repository to add")
public List remote;
}
}
```
Assuming you have packaged this as an executable program named 'git', you would be able to execute the following commands:
```shell
$ git add -p file
$ git remote add origin git@github.com:dain/git-like-cli.git
$ git -v remote show origin
```
Help System
===========
Git-like-cli contains a fully automated help system, which generates man-page-like documentation driven by the Java
annotations.
As you may have noticed in the code above, we added Help.class to the cli. This command is provided by Git-like-cli and works as follows:
```shell
$ git help
usage: git [-v] []
The most commonly used git commands are:
add Add file contents to the index
help Display help information
remote Manage set of tracked repositories
See 'git help ' for more information on a specific command.
$ git help git
NAME
git - the stupid content tracker
SYNOPSIS
git [-v] []
OPTIONS
-v
Verbose mode
COMMANDS
help
Display help information
add
Add file contents to the index
remote show
Gives some information about the remote
remote add
Adds a remote
$ git help add
NAME
git add - Add file contents to the index
SYNOPSIS
git [-v] add [-i] [--] [...]
OPTIONS
-i
Add modified contents interactively.
-v
Verbose mode
--
This option can be used to separate command-line options from the
list of argument, (useful when arguments might be mistaken for
command-line options
Patterns of files to be added
$ git help remote
NAME
git remote - Manage set of tracked repositories
SYNOPSIS
git [-v] remote
git [-v] remote add [-t ]
git [-v] remote show [-n]
OPTIONS
-v
Verbose mode
COMMANDS
With no arguments, Gives some information about the remote
show
Gives some information about the remote
With -n option, Do not query remote heads
add
Adds a remote
With -t option, Track only a specific branch
$ git help remote show
NAME
git remote show - Gives some information about the remote
SYNOPSIS
git [-v] remote show [-n] [--] []
OPTIONS
-n
Do not query remote heads
-v
Verbose mode
--
This option can be used to separate command-line options from the
list of argument, (useful when arguments might be mistaken for
command-line options
Remote to show
```
We have also, add Help.class as the default command for git, so if you execute git without any arguments, you will see the following:
```shell
$ git help
usage: git [-v] []
The most commonly used git commands are:
add Add file contents to the index
help Display help information
remote Manage set of tracked repositories
See 'git help ' for more information on a specific command.
```