@remkoj/optimizely-graph-cli 3.2.3 → 4.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +51 -2
- package/package.json +2 -3
package/README.md
CHANGED
|
@@ -1,2 +1,51 @@
|
|
|
1
|
-
# Optimizely
|
|
2
|
-
Command line utitilities to work with
|
|
1
|
+
# Optimizely Content Graph CLI
|
|
2
|
+
Command line utitilities to work with Optimizely Content Graph.
|
|
3
|
+
|
|
4
|
+
## Installation
|
|
5
|
+
Use your package manager of choice to install this package as development dependency.
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
yarn add --dev @remkoj/optimizely-graph-cli
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
This package installs the command `opti-graph` into the project, which can be used from your preferred package manager. For example from [yarn](https://yarnpkg.com/):
|
|
13
|
+
|
|
14
|
+
`yarn opti-graph <cmd> [args]`
|
|
15
|
+
|
|
16
|
+
### Commands
|
|
17
|
+
| Command | Description | Aliases |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| webhook:create [path] [verb] | Adds a webhook to Optimizely Graph that invokes /api/content/publish on every publish in Optimizely Graph | wc, register |
|
|
20
|
+
| webhook:delete [path] | Removes a webhook from ContentGraph that invokes /api/content/publish on every publish in ContentGraph | wd, unregister |
|
|
21
|
+
| webhook:list | List all webhooks in ContentGraph | wl, list |
|
|
22
|
+
| config:create [file_path] | ***Optimizely CMS 12 Only***: Generate a static site configuration file | cc, site-config |
|
|
23
|
+
| source:clear [sourceId] | Remove all data for the specified source | sc |
|
|
24
|
+
| source:list | List all content sources in Optimizely Graph | [default], sl |
|
|
25
|
+
| source:delete [sourceId] | Remove all data for the specified source | sd |
|
|
26
|
+
|
|
27
|
+
### Arguments
|
|
28
|
+
#### Frontend:
|
|
29
|
+
| Short | Argument | Description | Type | Default |
|
|
30
|
+
| --- | --- | --- | --- | --- |
|
|
31
|
+
| -f | --deploy_domain, --dd | Frontend domain | string | Environment variable: `SITE_DOMAIN` |
|
|
32
|
+
|
|
33
|
+
#### Optimizely CMS Instance:
|
|
34
|
+
| Short | Argument | Description | Type | Default |
|
|
35
|
+
| --- | --- | --- | --- | --- |
|
|
36
|
+
| -c | --dxp_url, --du | Optimizely CMS URL | string | Environment variable: `OPTIMIZELY_CMS_URL` |
|
|
37
|
+
|
|
38
|
+
#### Optimizely Graph Instance:
|
|
39
|
+
| Short | Argument | Description | Type | Default |
|
|
40
|
+
| --- | --- | --- | --- | --- |
|
|
41
|
+
| -a | --app_key, --ak | Content Graph App Key | string | Environment variable: `OPTIMIZELY_GRAPH_APP_KEY` |
|
|
42
|
+
| -s | --secret | Content Graph Secret | string | Environment variable: `OPTIMIZELY_GRAPH_SECRET` |
|
|
43
|
+
| -k | --single_key, --sk | Content Graph Single Key | string | Environment variable: `OPTIMIZELY_GRAPH_SINGLE_KEY` |
|
|
44
|
+
| -g | --gateway | Content Graph Gateway | string | Environment variable: `OPTIMIZELY_GRAPH_GATEWAY`, if not set or empty: https://cg.optimizely.com |
|
|
45
|
+
|
|
46
|
+
#### Debugging:
|
|
47
|
+
| Short | Argument | Description | Type | Default |
|
|
48
|
+
| --- | --- | --- | --- | --- |
|
|
49
|
+
| | --verbose | Enable query logging | boolean | |
|
|
50
|
+
| | --help | Show help | boolean | |
|
|
51
|
+
| | --version | Show version number | boolean | |
|
package/package.json
CHANGED
|
@@ -3,9 +3,8 @@
|
|
|
3
3
|
"repository": "https://github.com/remkoj/optimizely-dxp-clients.git",
|
|
4
4
|
"author": "Remko Jantzen <693172+remkoj@users.noreply.github.com>",
|
|
5
5
|
"homepage": "https://github.com/remkoj/optimizely-dxp-clients",
|
|
6
|
-
"version": "
|
|
6
|
+
"version": "4.0.0",
|
|
7
7
|
"license": "Apache-2.0",
|
|
8
|
-
"packageManager": "yarn@4.1.1",
|
|
9
8
|
"type": "module",
|
|
10
9
|
"description": "CLI Utilities for Optimizely DXP",
|
|
11
10
|
"main": "dist/index.js",
|
|
@@ -21,7 +20,7 @@
|
|
|
21
20
|
"opti-graph": "yarn node bin/index.js"
|
|
22
21
|
},
|
|
23
22
|
"devDependencies": {
|
|
24
|
-
"@remkoj/optimizely-graph-client": "
|
|
23
|
+
"@remkoj/optimizely-graph-client": "4.0.0",
|
|
25
24
|
"@rollup/plugin-commonjs": "^28.0.1",
|
|
26
25
|
"@rollup/plugin-json": "^6.1.0",
|
|
27
26
|
"@rollup/plugin-typescript": "^12.1.1",
|