Skip to content

Commit

Permalink
Project has moved to https://github.com/airlift/airline
Browse files Browse the repository at this point in the history
  • Loading branch information
@dain
dain committed Jul 25, 2012
1 parent 807bca0 commit 590f85e
Show file tree
Hide file tree
Showing 66 changed files with 4 additions and 6,644 deletions.
17 changes: 0 additions & 17 deletions .gitignore
View file

This file was deleted.

221 changes: 4 additions & 217 deletions README.md
View file
@@ -1,220 +1,7 @@
Git-like-cli Moved
============ =====


Git-like-cli is a Java annotation-based framework for parsing Git like command line structures. Git-like-cli as been renamed and moved to **[Airline](https://github.com/airlift/airline)** ([https://github.com/airlift/airline](https://github.com/airlift/airline)).


Latest release is 0.3, available from Maven Central. The old Git-like-cli code can be found in the [old-master](https://github.com/dain/git-like-cli/tree/old-master) branch.


Here is a quick example:

```java
public class Git
{
public static void main(String[] args)
{
CliBuilder<Runnable> builder = Cli.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);

Cli<Runnable> gitParser = builder.build();

gitParser.parse(args).run();
}

public static class GitCommand implements Runnable
{
@Option(type = OptionType.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<String> patterns;

@Option(name = "-i", description = "Add modified contents interactively.")
public boolean interactive;
}

@Command(name = "show", description = "Gives some information about the remote <name>")
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<String> 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] <command> [<args>]

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 <command>' for more information on a specific command.


$ git help git
NAME
git - the stupid content tracker

SYNOPSIS
git [-v] <command> [<args>]

OPTIONS
-v
Verbose mode

COMMANDS
help
Display help information

add
Add file contents to the index

remote show
Gives some information about the remote <name>

remote add
Adds a remote



$ git help add
NAME
git add - Add file contents to the index

SYNOPSIS
git [-v] add [-i] [--] [<patterns>...]

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>
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 <branch>]
git [-v] remote show [-n]

OPTIONS
-v
Verbose mode

COMMANDS
With no arguments, Gives some information about the remote <name>

show
Gives some information about the remote <name>

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 <name>

SYNOPSIS
git [-v] remote show [-n] [--] [<remote>]

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>
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] <command> [<args>]
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 <command>' for more information on a specific command.
```

0 comments on commit 590f85e

Please sign in to comment.