open-index/open-npm huggingface dataset:
npm package: @garoon/plugin-packer
Description: Package your Garoon plugin
Author: Cybozu, Inc.
Latest version: 1.2.2

garoon-plugin-packer
====

plugin-packer for Garoon plugins.

It's written in pure JavaScript, so

- The CLI works with Node.js in Mac/Windows/Linux
- Validate your manifest.json with JSON Schema

# How to install

```shell script
$ npm install -g @garoon/plugin-packer
```

# Usage: CLI

```shell script
$ garoon-plugin-packer [OPTIONS] PLUGIN_DIR
```

## Options

- `--out PLUGIN_FILE`: The path of generated plugin file. The default is `plugin.zip` in the same directory of PLUGIN_DIR.

## How to use with `npm run`

The plugin directory is ./plugin, edit package.json:

```json
{
  "scripts": {
    "package": "garoon-plugin-packer plugin"
  }
}
```

and then

```shell script
$ npm run package
```

# Usage: Node.js API

```js
const { packer } = require("@garoon/plugin-packer");

packer("./pluginDir");
```

## Licence

MIT License
npm package: @garoon/plugin-uploader
Description: plugin uploader for Garoon.
Author: Cybozu, Inc.
Latest version: 2.0.5

# garoon-plugin-uploader
Garoon plugin uploader using [puppeteer](https://github.com/puppeteer/puppeteer).

Note: In environments where only SAML authentication is enabled, only Users & System Administrators can use this uploader to upload plugins. ([References](https://jp.cybozu.help/general/en/id/02036.html#list_saml_saml_restriction_20))

## Install

```
$ npm install -D @garoon/plugin-uploader
```

or

```
$ npm install -g @garoon/plugin-uploader
```

## Usage

```
$ cd your_project
```

### Apply the plugin to Garoon for the first time

```
$ garoon-plugin-uploader \
--base-url ${yourGaroonBaseUrl} \
--username ${yourLoginName} \
--password ${yourPassword} \
--plugin-path ${pluginZipPath}
```

### Update existing plugin

```
$ garoon-plugin-uploader \
--base-url ${yourGaroonBaseUrl} \
--username ${yourLoginName} \
--password ${yourPassword} \
--plugin-path ${pluginZipPath} \
--plugin-id ${pluginId}
```

## Options

```
$ garoon-plugin-uploader --help

Options:
  --version              Show version number                           [boolean]
  --base-url             Garoon base url to apply plugin's zip. example)
                         https://example.cybozu.com/         [string] [required]
  --username             Garoon username                     [string] [required]
  --password             Garoon password                     [string] [required]
  --plugin-path          existing plugin's zip path          [string] [required]
  --plugin-id            plugin's id                                    [string]
  --basic-auth-username  username for Basic Authentication               [string]
  --basic-auth-password  password for Basic Authentication               [string]
  --proxy                IP or hostname for proxy server                 [string]
  --help                 Show help                                     [boolean]
```

> You can set the values through environment variables.<br />
>  --base-url: GAROON_BASE_URL<br />
>  --username: GAROON_USERNAME<br />
>  --password: GAROON_PASSWORD<br />
>  --basic-auth-username: GAROON_BASIC_AUTH_USERNAME<br />
>  --basic-auth-password: GAROON_BASIC_AUTH_PASSWORD<br />
>  --proxy: HTTPS_PROXY or HTTP_PROXY<br />


## License

MIT License