8000 modgit/README.md at 0.1 · jreinke/modgit · GitHub
[go: up one dir, main page]

Skip to content

Latest commit

 

History

History
79 lines (46 loc) · 1.84 KB

README.md

File metadata and controls

79 lines (46 loc) · 1.84 KB

Deploy Git modules with include/exclude features

modgit is an alternative to the excellent modman tool. Directly inspired from it, modgit allows you to deploy Git modules physically in your project (no symlinks). Additionaly, you can define include/exclude filters to deploy only files and folders of your choice.

Requirements

  • bash
  • git

Installation

curl installation

wget installation

Manual download

  • Download shell script from download page
  • Copy modgit file to /usr/local/bin (or any folder in your $PATH)
  • Performs chmod +x modgit

Usage

Install a module:

$ cd /my/project/path
$ modgit init
$ modgit clone <module> <git_repository>

Update a module:

$ modgit update <module>

Update all modules:

$ modgit update-all

Remove a module:

$ modgit remove <module>

Remove all modules:

$ modgit remove-all

List installed modules:

$ modgit list

Advanced usage

Include filter:

$ modgit -i lib/ clone elastica git://github.com/ruflin/Elastica.git

Include filter with custom target:

$ modgit -i lib:library clone elastica git://github.com/ruflin/Elastica.git

Exclude filter:

$ modgit -e tests clone atoum https://github.com/mageekguy/atoum

Automatic modman compatibility (parse remote modman file for files and folders mapping):

$ modgit clone magneto-debug https://github.com/madalinoprea/magneto-debug.git

Git options:

$ modgit clone elastica https://github.com/ruflin/Elastica.git --branch gh-pages

Coming soon

  • Add dry-run option
0