# o3-panther-cli

> Panther command line interface by Origmai 3

The Panther command line interface allows users to quickly develop against a remote Panther server. On first run of the commands a configuration file, o3.json, will be used for configuration. If the configuration file does not exist a series of questions will be asked to generate a new one.

Proxy functionality allows local content to be visible in a browser window. Content from a remote Panther server is proxied to simulate a production environment. The editing of local content will be viewable in a browser usually at https://localhost:8443. 

The deploy option creates a zip file of artifacts and publishes them to the Panther server. Files will be published to the designated host defined in the o3.json configuration file. 

## Installation

Install with `npm install o3-panther-cli`.


## Usage

To simplify development add the following to the package.json file under the "scripts" element.

```json
    "deploy": "node node_modules/o3-panther-cli deploy",
    "start": "node node_modules/o3-panther-cli server"
```

After the package.json has been updated the following command will start the proxy server.

```sh
    npm start
```

Execute the following command to deploy the code to the Panther site.

```sh
    npm run deploy
```

To view the help information for available commands run the following from a shell.

```sh
    node node_modules/o3-panther-cli -h
```

The response should be

```
  Usage: index [options] [command]


  Options:

    -v, --version  output the version number
    -h, --help     output usage information


  Commands:

    server  Start a local http server and proxy remote Panther requests.
    deploy  Upload the local www directory to the Panther site.
    init    Create an o3.json configuration file

```

## Contributing

We would love you to contribute to `o3-panther-cli`, pull requests are very welcomed!
Please see [CONTRIBUTING.md](CONTRIBUTING.md) for more information.

## LICENSE

[Apache-2.0](LICENSE)