#+TITLE: gitto
#+LINK_UP: ../index.html
#+LINK_HOME: http://ryuslash.org
#+LINK: src    https://github.com/ryuslash/gitto
#+LINK: tar_gz https://github.com/ryuslash/gitto/tarball/master
#+LINK: zip    https://github.com/ryuslash/gitto/zipball/master
#+STARTUP: show all

#+begin_html
  <script src="/keyjs.KS" type="text/javascript"></script>
  <script type="text/javascript">
    keyjs_initialize({ "u": [ "keyjs_goto", "../index.html" ],
                       "h": [ "keyjs_goto", "http://ryuslash.org" ] });
  </script>
#+end_html

#+INCLUDE: "dlmenu.inc"

* About

  ~gitto~ is a utility written in [[http://www.gnu.org/software/guile/][Guile scheme]] to help me keep track of
  the status of my git repositories.

** Features

   - Show a list of how many commits to pull or push and whether or
     not the working directory of that repository is dirty.

** Requirements

   - [[http://www.gnu.org/software/guile/][Guile]] v2.0.x
   - [[http://git-scm.com][git]]

* Usage

** Register repositories

   First you'll have to register some repositories:

   #+begin_example
     $ gitto -r ~/projects/project1
     $ gitto -r ~/projects/project2
     $ gitto -r ~/projects/project3
   #+end_example

** List status

   Once you have registered some repositories you can list them by
   calling ~gitto~ without any arguments:

   #+begin_example
     $ gitto
     project1:      0 to push, 0 to pull and is dirty
     project2:      5 to push, 2 to pull and is not dirty
     project3:      0 to push, 1 to pull and is not dirty
   #+end_example

** Remove repositories

   When you're fed up with a repository and no longer care about its
   status, you can remove it with the =-R= switch:

   #+begin_src shell-script
     $ gitto -R ~/projects/project1
   #+end_src