Skip to content

Commit

Permalink
Added an improved README per @jaypipes
Browse files Browse the repository at this point in the history
  • Loading branch information
retr0h committed Aug 6, 2018
1 parent 13fc48f commit 59e4507
Showing 1 changed file with 29 additions and 6 deletions.
35 changes: 29 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,35 @@

# go-gilt

Gilt is a tool which aims to make Ansible repo management, managable. Gilt
clones repositories at a particular version, then overlays the repository to
the provided destination.

What makes Gilt interesting, is the ability to overlay particular files and/or
directories from the specified repository to given destinations. This is quite
hepful when working with Ansible, since libraries, plugins, and playbooks are
often shared, but [Galaxy][1] has no mechanism to cleanly handle this.

[1]: https://docs.ansible.com/ansible/latest/reference_appendices/galaxy.html

## Port

This project is a port of [Gilt](http:https://gilt.readthedocs.io/en/latest/), it is
not 100% compatible with the python version, and not yet complete.

## Installation

$ go get github.com/retr0h/gofile

## Usage

### Overlay Repository

Create the giltfile (`gilt.yml`).

Clone the specified `url`@`version` to the configurable path `--giltdir`, and
extract the repository to the provided `dst`.

```yaml
---
- url: https://github.com/retr0h/ansible-etcd.git
Expand All @@ -25,22 +46,24 @@ Overlay a remote repository into the destination provided.
$ gilt overlay
```

Optionally, override gilt's cache location (defaults to `~/.gilt/cache`):
Use an alternate config file (default `gilt.yml`).

```bash
$ gilt --giltdir ~/alternate/directory overlay
$ gilt overlay --filename /path/to/gilt.yml
```

Display the git commands being executed.
Optionally, override gilt's cache location (defaults to `~/.gilt/clone`):

```bash
$ gilt --debug overlay
$ gilt --giltdir ~/alternate/directory overlay
```

Use an alternate config file (default `gilt.yml`).
### Debug

Display the git commands being executed.

```bash
$ gilt overlay --filename /path/to/gilt.yml
$ gilt --debug overlay
```

[![asciicast](https://asciinema.org/a/195036.png)](https://asciinema.org/a/195036?speed=2&autoplay=1&loop=1)
Expand Down

0 comments on commit 59e4507

Please sign in to comment.