<commit_before>[![Gem Version](https://badge.fury.io/rb/manifestly.svg)](http://badge.fury.io/rb/manifestly)
[![Build Status](https://travis-ci.org/openstax/manifestly.svg?branch=master)](https://travis-ci.org/openstax/manifestly)

# Manifestly

Manifestly helps you manage complicated deployments involving multiple sites and git repositories.

## Installation

Manifestly is run as a standalone executable.  Install with:

    $ gem install manifestly

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install manifestly

## Usage

Manifestly has built in help:

    $ manifestly help

_Note_: underscores and hyphens are interchangeable in option names, e.g. `--search_paths=blah` is the same as `--search-paths=blah`.

### create

To create a new manifest, run

    $ manifestly create

Both `create` and `apply` take a `--search-paths` option to specify where the repositories of interest can be found.  The default search path is the current directory.

`create` by default is non-interactive (see `$>manifestly help create`) but there is an interactive option that will show you a blank manifest and give you options to add or remove repositories, or to choose the manifest commit for an existing repository.  When repositories are added, their latest commit is listed.  All commits seen during manifest creation are local commits only -- this tool does not look up remote commits.

### upload

To push a manifest file you have created, call:

    $ manifestly upload --local=my_file.manifest --mfrepo=myorg/myrepo --remote=foo

This will take your local file and push it as the latest commit on top of the `foo` file at github.com/myorg/myrepo.
<commit_msg>installation clarifications<commit_after>[![Gem Version](https://badge.fury.io/rb/manifestly.svg)](http://badge.fury.io/rb/manifestly)
[![Build Status](https://travis-ci.org/openstax/manifestly.svg?branch=master)](https://travis-ci.org/openstax/manifestly)

# Manifestly

Manifestly helps you manage complicated deployments involving multiple sites and git repositories.

## Installation

Manifestly is run as a standalone executable.  Install with:

    $ gem install manifestly

To update to the latest version:

    $ gem update manifestly

## Usage

Manifestly has built in help:

    $ manifestly help

_Note_: underscores and hyphens are interchangeable in option names, e.g. `--search_paths=blah` is the same as `--search-paths=blah`.

### create

To create a new manifest, run

    $ manifestly create

Both `create` and `apply` take a `--search-paths` option to specify where the repositories of interest can be found.  The default search path is the current directory.

`create` by default is non-interactive (see `$>manifestly help create`) but there is an interactive option that will show you a blank manifest and give you options to add or remove repositories, or to choose the manifest commit for an existing repository.  When repositories are added, their latest commit is listed.  All commits seen during manifest creation are local commits only -- this tool does not look up remote commits.

### upload

To push a manifest file you have created, call:

    $ manifestly upload --local=my_file.manifest --mfrepo=myorg/myrepo --remote=foo

This will take your local file and push it as the latest commit on top of the `foo` file at github.com/myorg/myrepo.

{'fraction_non_alphanumeric': 0.08214285714285714, 'fraction_numerical': 0.0, 'mean_word_length': 4.218944099378882, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 5, 'https://': 6, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '7496788', 'n_tokens_mistral': 968, 'n_tokens_neox': 910, 'n_words': 408}