checkout-install

CLI utility to pull upstream changes and run npm install / npm link if changes to to package.json

Usage

usage: checkout-install [options]

Options:
  --version, -v   Show version number                                  [boolean]
  --help          Show help                                            [boolean]
  -c, --config    Path to JSON config file
                                        [string] [default: ".checkoutinstallrc"]
  -n, --name      Name to use in logging                                [string]
  -u, --upstream  Upstream branch to pull                    [default: "master"]
  -r, --remote    Remote to pull from                        [default: "origin"]
  -l, --links     links to setup after install             [array] [default: []]
  --log-level     Logging level to use
         [choices: "trace", "debug", "info", "warn", "error", "fatal", "silent"]
                                                               [default: "info"]

Note that you can provide options in the `checkout-install` key in package.json

You can pass all configuration options through a JSON file via --config

Configuration file defaults to .checkoutinstallrc - it will be parsed as JSON.

You can also provide a checkout-install key inside package.json

Multiple Repositories

If using a config file or package.json config, you can pass multiple repositories via the repositories key. Each repository supports the same set of configuration options in addition to a path key used to point at the target directory.

Example

{
  "repositories": [
    {
      "upstream": "development",
      "path": "../repo-1",
      "links": ["module-1", "module-2"]
    },
    {
      "upstream": "development",
      "remote": "upstream",
      "path": "../repo-2"
    },
    {
      "upstream": "development",
      "path": "../repo-3",
      "links": ["module-1", "module-2"]
    }
  ]
}