ANTWAR

NAME
SYNOPSIS
DESCRIPTION
COMMANDS
EXIT STATUS
EXAMPLE
FILES
AUTHORS
BUGS
NOTES
SEE ALSO

NAME

antwar − Distributed issue tracker using git.

SYNOPSIS

antwar command [ args ]

DESCRIPTION

Antwar is a distributed issue tracker for git. It keeps all information in the .issue/ directory located in the root of the project in a separate branch called issues.

File structure

Image grohtml-261421.png

Commands
Each command is a separate program named antwar-<command>, e.g. antwar-show. These programs is to be found somewhere where PATH points or relative the antwar binary in ../lib/antwar/.

For every command issued it will essentially work like this:

Image grohtml-261422.png

COMMANDS

init

Creates a new issue tracking system. This has to be done once before starting to use the issue tracker.

new

Create a new issue.

list

List issues.

show

Show an issue.

fix

Mark an issue as fixed.

edit

Make changes to an issue.

comment

Create a comment on an issue.

log

Show what has happened lately.

sync

Synchronize your issue tracker with origin/issues. Is also used to clone the issue tracker from origin/issues.

EXIT STATUS

An exit status different from zero means there has been an error. If you are curious of what caused it and are unsatisfied with the information printed to you, take a look in the source code. The number should be different enough so you can use grep on the files and not be overwhelmed with the results, e.g. grep -B 3 ’Exit(1)’ src/command/*/*.go gives you a pretty good idea of what went wrong.

EXAMPLE

It all makes more sense with an example...
antwar init

Create the new issue tracker.

antwar new -t "New example issue."

Create new issues.

antwar list -bug -relevance high

Show issues which are bugs and have a relevance of high or blocker (>=high).

antwar show hf1337

Show the issue with a hash starting with hf1337 and its comments. The hash can be given as short as you like as long as it is unique.

antwar fix hf1337 -w

Mark the issue with hash hf1337 as wontfix.

antwar fix hf1337 -o

Reopen the issue with hash hf1337.

antwar edit hf1337

Change e.g. the title or the description for the issue with hash hf1337.

antwar comment hf1337

Leave a comment on the issue with hash hf1337.

antwar log -n 5

Show the 5 most recent changes.

antwar sync

Synchronises the issue tracker or if it was no issue tracker on your computer, clone the one in origin/issues.

FILES

~/.antwar.cfg

User-specific configuration file. If it does not exist, you will be prompted for information and the file will be created for you.

AUTHORS

Image grohtml-261423.png

BUGS

If you find a bug please send an email to the authors and a patch if you know how to solve it.

NOTES

Merge conflict
If two users edit the same issue option, the second one who syncs will receive an "Automatic merge failed;" from git and be left in the issues branch. You need to solve this issue by hand before you can change branch again. As git puts it: "fix conflicts and then commit the result.". To solve the conflict run git mergetool (meld is a good tool). When it is solved, commit it and then you can change branch and sync again.

SEE ALSO

For more specific information on how to operate each command use the -h switch and your common sense.