From deb9d52cfcef5b4b952126d83fc0590b3a8c35b2 Mon Sep 17 00:00:00 2001 From: Ben Kurtovic Date: Sun, 5 Jun 2011 19:27:51 -0400 Subject: [PATCH] initial commit of text files --- .gitignore | 1 + LICENSE | 19 +++++++++++++++ README.md | 78 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 98 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 README.md diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..567609b --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +build/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..6572aa7 --- /dev/null +++ b/LICENSE @@ -0,0 +1,19 @@ +Copyright (c) 2011 by Ben Kurtovic + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies +of the Software, and to permit persons to whom the Software is furnished to do +so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..c88a95c --- /dev/null +++ b/README.md @@ -0,0 +1,78 @@ +__gitup__ (the _git-repo-updater_) + +gitup is a tool designed to pull to a large number of git repositories at once. +It is smart enough to ignore projects with dirty working directories, and +provides a great way to get everything up-to-date for those short periods of +internet access between long periods of none. + +gitup works on both OS X and Linux. You should have the latest version of git +and at least Python 2.7 installed. + +# Installation + +First: + + git clone git://github.com/earwig/git-repo-updater.git + cd git-repo-updater + +Then, to install for everyone: + + sudo python setup.py install + +...or for just yourself (make sure you have `~/.local/bin` in your PATH): + + python setup.py install --user + +Finally, simply delete the `git-repo-updater` directory, and you're done! + +# Usage + +There are two ways to update projects: you can pass them as command arguments, +or save them as "bookmarks". + +For example: + + gitup ~/projects/foo ~/projects/bar ~/projects/baz + +...will automatically pull to the `foo`, `bar`, and `baz` git repositories if +their working directories are clean (to avoid merge conflicts). Additionally, +you can just type: + + gitup ~/projects + +...to automatically update all git repositories in that directory. + +To add a bookmark (or bookmarks), either of these will work: + + gitup --add ~/projects/foo ~/projects/bar ~/projects/baz + gitup --add ~/projects + +Then, to update (pull to) all of your bookmarks, just run gitup without args: + + gitup + +Deleting a bookmark is as easy as adding one: + + gitup --delete ~/projects + +Want to view your current bookmarks? Simple: + + gitup --list + +You can mix and match bookmarks and command arguments: + + gitup --add ~/projects/foo ~/projects/bar + gitup ~/projects/baz # update 'baz' only + gitup # update 'foo' and 'bar' only + gitup ~/projects/baz --update # update all three! + +Want to update all git projects in your current directory? + + gitup . + +For a list of all command arguments and abbreviations: + + gitup --help + +Finally, all paths can be either absolute (e.g. /path/to/project) or relative +(e.g. ../my/project).