[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

TWCable/grabbit-cli

Repository files navigation

Grabbit Command Line Interface

Description

This script starts and monitors a Grabbit content sync.

download

Stories in Ready

Usage

Prerequisites

You must first install the Grabbit AEM package on any instance you wish to sync content to (i.e. a Grabbit client). You can download the latest package from bintray: https://bintray.com/twcable/aem/Grabbit/view#files See the Grabbit project page for more information.

Finally, the distributed binaries are self-executing Java programs (thanks to the awesome Capsule packager). The only requirement is that you have the Java 8+ runtime installed.

Running

Download the binary from download

Note

If you’re running on Windows, you need to put java -jar in front of grabbit-cli.

e.g., java -jar grabbit-cli -h

For the instructions below, assuming that you’ve renamed the binary you chose to grabbit-cli:

(If you downloaded the file from BinTray, you may need to set the execute bit on it first to use on a *nix system: chmod u+x grabbit-cli)

Run grabbit-cli -h to view list of options:

usage: grabbit-cli -[h|s|sm|m] [grabbit-json-file] [env-json-file] [env] [grabbit-ids-file]

  -h,--help                                                                 Show usage information
  -m,--monitor <[env-json-file] [environment] [grabbit-ids-file]>           Monitor grabbit
  -s,--start <[grabbit-json-file] [env-json-file] [environment]>            Start grabbit
  -sm,--start-monitor <[grabbit-json-file] [env-json-file] [environment]>   Start and monitor grabbit

Example for syncing to your local author:

grabbit-cli -sm grabbit-author.json localhost.json localhost

Example for syncing to your local publish:

grabbit-cli -sm grabbit-publish.json localhost.json localhost
Note

For now, check the Grabbit documentation for the format of the environment/configuration files.

LICENSE

Copyright 2014-2016 Time Warner Cable, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.