Skip to content
This repository was archived by the owner on Jan 12, 2026. It is now read-only.

8.2.9 #302

Merged
acunniffe merged 1 commit into from
Aug 6, 2020
Merged

8.2.9 #302

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 11 additions & 7 deletions workspaces/agent-cli/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ $ npm install -g @useoptic/agent-cli
$ optic-agent COMMAND
running command...
$ optic-agent (-v|--version|version)
@useoptic/agent-cli/8.1.0 darwin-x64 node-v12.4.0
@useoptic/agent-cli/8.2.9 darwin-x64 node-v12.4.0
$ optic-agent --help [COMMAND]
USAGE
$ optic-agent COMMAND
Expand All @@ -46,21 +46,25 @@ OPTIONS
--all see all commands in CLI
```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.0.1/src/commands/help.ts)_
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.1.0/src/commands/help.ts)_

## `optic-agent run`

start your API process with Optic monitoring
Monitor your API with Optic, given a capture configuration generated by optic-ci

```
USAGE
$ optic-agent run

OPTIONS
--command=command (required) the command to start your API
--config=config (required) the output from optic-ci capture:start
--listen=listen (required) host:port Optic should start on
--command=command (required, or --targetUrl) the command to start your API
--config=config (required) the output from optic-ci capture:start
--listen=listen (required) host:port Optic should listen on (aliases: --baseUrl, --inboundUrl)
--targetUrl=targetUrl (required, or --command) the url where your API is available

EXAMPLE
$ optic-agent run --command="npm start" --config=$CAPTURE_CONFIG --listen=http://localhost:3001
```

_See code: [src/commands/run.ts](https://github.com/useoptic/optic-package/blob/v8.1.0/src/commands/run.ts)_
_See code: [src/commands/run.ts](https://github.com/useoptic/optic-package/blob/v8.2.9/src/commands/run.ts)_
<!-- commandsstop -->
4 changes: 2 additions & 2 deletions workspaces/agent-cli/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@useoptic/agent-cli",
"version": "8.2.8",
"version": "8.2.9",
"author": "@useoptic",
"bin": {
"optic-agent": "./bin/run"
Expand All @@ -15,7 +15,7 @@
"@oclif/command": "^1",
"@oclif/config": "^1",
"@oclif/plugin-help": "^3",
"@useoptic/cli-shared": "8.2.8",
"@useoptic/cli-shared": "8.2.9",
"dotenv": "^8.2.0",
"jwt-decode": "^2.2.0",
"tslib": "^1",
Expand Down
37 changes: 20 additions & 17 deletions workspaces/ci-cli/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,28 +16,28 @@
<!-- usage -->
```sh-session
$ npm install -g @useoptic/ci-cli
$ optic-agent COMMAND
$ optic-ci COMMAND
running command...
$ optic-agent (-v|--version|version)
@useoptic/ci-cli/8.1.0 darwin-x64 node-v12.4.0
$ optic-agent --help [COMMAND]
$ optic-ci (-v|--version|version)
@useoptic/ci-cli/8.2.9 darwin-x64 node-v12.4.0
$ optic-ci --help [COMMAND]
USAGE
$ optic-agent COMMAND
$ optic-ci COMMAND
...
```
<!-- usagestop -->
# Commands
<!-- commands -->
* [`optic-agent capture:start`](#optic-agent-capturestart)
* [`optic-agent help [COMMAND]`](#optic-agent-help-command)
* [`optic-ci capture:start`](#optic-ci-capturestart)
* [`optic-ci help [COMMAND]`](#optic-ci-help-command)

## `optic-agent capture:start`
## `optic-ci capture:start`

describe the command here
starts an Optic CI capture session and returns a capture configuration which can be fed to optic-agent

```
USAGE
$ optic-agent capture:start
$ optic-ci capture:start

OPTIONS
--build-id=build-id (required) a unique identifier representing the version of the code, build process, and
Expand All @@ -50,19 +50,22 @@ OPTIONS

--environment=environment (required) the name of the environment you are deploying into

EXAMPLE
$ optic-ci capture:start ???
EXAMPLES
$ optic-ci capture:start --deployment-id=<version_number> --build-id=<changeset_hash> --environment=<environment_name>
--config=optic.yml
$ CAPTURE_CONFIG=$(optic-ci capture:start --deployment-id=<...> --build-id=<...> --environment=<...>
--config=optic.yml)
```

_See code: [src/commands/capture/start.ts](https://github.com/useoptic/optic-package/blob/v8.1.0/src/commands/capture/start.ts)_
_See code: [src/commands/capture/start.ts](https://github.com/useoptic/optic-package/blob/v8.2.9/src/commands/capture/start.ts)_

## `optic-agent help [COMMAND]`
## `optic-ci help [COMMAND]`

display help for optic-agent
display help for optic-ci

```
USAGE
$ optic-agent help [COMMAND]
$ optic-ci help [COMMAND]

ARGUMENTS
COMMAND command to show help for
Expand All @@ -71,5 +74,5 @@ OPTIONS
--all see all commands in CLI
```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.0.1/src/commands/help.ts)_
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.1.0/src/commands/help.ts)_
<!-- commandsstop -->
6 changes: 3 additions & 3 deletions workspaces/ci-cli/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@useoptic/ci-cli",
"version": "8.2.8",
"version": "8.2.9",
"author": "@useoptic",
"bin": {
"optic-ci": "./bin/run"
Expand All @@ -15,8 +15,8 @@
"@oclif/command": "^1",
"@oclif/config": "^1",
"@oclif/plugin-help": "^3",
"@useoptic/cli-config": "8.2.8",
"@useoptic/cli-shared": "8.2.8",
"@useoptic/cli-config": "8.2.9",
"@useoptic/cli-shared": "8.2.9",
"dotenv": "^8.2.0",
"jwt-decode": "^2.2.0",
"tslib": "^1",
Expand Down
6 changes: 3 additions & 3 deletions workspaces/cli-client/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@useoptic/cli-client",
"version": "8.2.8",
"version": "8.2.9",
"scripts": {
"ws:build": "yarn run tsc -b --verbose",
"ws:clean": "rm -rf build/*",
Expand All @@ -14,8 +14,8 @@
"main": "build/index.js",
"types": "build/index.d.ts",
"dependencies": {
"@useoptic/cli-config": "8.2.8",
"@useoptic/client-utilities": "8.2.8",
"@useoptic/cli-config": "8.2.9",
"@useoptic/client-utilities": "8.2.9",
"bottleneck": "^2.19.5",
"cross-fetch": "^3.0.4"
},
Expand Down
2 changes: 1 addition & 1 deletion workspaces/cli-config/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@useoptic/cli-config",
"version": "8.2.8",
"version": "8.2.9",
"scripts": {
"ws:test": "echo config",
"ws:build": "yarn run tsc -b --verbose",
Expand Down
4 changes: 2 additions & 2 deletions workspaces/cli-scripts/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@useoptic/cli-scripts",
"version": "8.2.8",
"version": "8.2.9",
"scripts": {
"ws:test": "echo scripts",
"ws:build": "yarn run tsc -b --verbose",
Expand All @@ -16,7 +16,7 @@
"dependencies": {
"node-notifier": "^7.0.0",
"analytics-node": "^3.4.0-beta.1",
"@useoptic/cli-shared": "8.2.8"
"@useoptic/cli-shared": "8.2.9"
},
"devDependencies": {
"@types/node-notifier": "^6.0.1"
Expand Down
12 changes: 6 additions & 6 deletions workspaces/cli-server/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@useoptic/cli-server",
"version": "8.2.8",
"version": "8.2.9",
"scripts": {
"ws:build": "yarn run tsc -b --verbose",
"ws:clean": "rm -rf build/*",
Expand All @@ -14,11 +14,11 @@
"main": "build/index.js",
"types": "build/index.d.ts",
"dependencies": {
"@useoptic/cli-client": "8.2.8",
"@useoptic/cli-config": "8.2.8",
"@useoptic/cli-scripts": "8.2.8",
"@useoptic/cli-shared": "8.2.8",
"@useoptic/ui": "8.2.8",
"@useoptic/cli-client": "8.2.9",
"@useoptic/cli-config": "8.2.9",
"@useoptic/cli-scripts": "8.2.9",
"@useoptic/cli-shared": "8.2.9",
"@useoptic/ui": "8.2.9",
"avsc": "^5.4.18",
"body-parser": "^1.19.0",
"cors": "^2.8.5",
Expand Down
8 changes: 4 additions & 4 deletions workspaces/cli-shared/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@useoptic/cli-shared",
"version": "8.2.8",
"version": "8.2.9",
"scripts": {
"ws:build": "yarn run tsc -b --verbose",
"ws:clean": "rm -rf build/*",
Expand All @@ -15,9 +15,9 @@
"types": "build/index.d.ts",
"dependencies": {
"@oclif/command": "^1.6.1",
"@useoptic/cli-client": "8.2.8",
"@useoptic/cli-config": "8.2.8",
"@useoptic/client-utilities": "8.2.8",
"@useoptic/cli-client": "8.2.9",
"@useoptic/cli-config": "8.2.9",
"@useoptic/client-utilities": "8.2.9",
"@useoptic/domain": "10.0.3",
"@useoptic/domain-types": "10.0.3",
"@useoptic/domain-utilities": "10.0.3",
Expand Down
2 changes: 1 addition & 1 deletion workspaces/client-utilities/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@useoptic/client-utilities",
"version": "8.2.8",
"version": "8.2.9",
"scripts": {
"ws:build": "yarn run tsc -b --verbose",
"ws:clean": "rm -rf build/*",
Expand Down
18 changes: 9 additions & 9 deletions workspaces/local-cli/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ $ npm install -g @useoptic/cli
$ api COMMAND
running command...
$ api (-v|--version|version)
@useoptic/cli/8.1.0 darwin-x64 node-v12.4.0
@useoptic/cli/8.2.9 darwin-x64 node-v12.4.0
$ api --help [COMMAND]
USAGE
$ api COMMAND
Expand Down Expand Up @@ -47,7 +47,7 @@ USAGE
$ api check [TASKNAME]
```

_See code: [src/commands/check.ts](https://github.com/useoptic/optic-package/blob/v8.1.0/src/commands/check.ts)_
_See code: [src/commands/check.ts](https://github.com/useoptic/optic-package/blob/v8.2.9/src/commands/check.ts)_

## `api generate:oas`

Expand All @@ -62,7 +62,7 @@ OPTIONS
--yaml
```

_See code: [src/commands/generate/oas.ts](https://github.com/useoptic/optic-package/blob/v8.1.0/src/commands/generate/oas.ts)_
_See code: [src/commands/generate/oas.ts](https://github.com/useoptic/optic-package/blob/v8.2.9/src/commands/generate/oas.ts)_

## `api help [COMMAND]`

Expand Down Expand Up @@ -90,7 +90,7 @@ USAGE
$ api init
```

_See code: [src/commands/init.ts](https://github.com/useoptic/optic-package/blob/v8.1.0/src/commands/init.ts)_
_See code: [src/commands/init.ts](https://github.com/useoptic/optic-package/blob/v8.2.9/src/commands/init.ts)_

## `api login`

Expand All @@ -101,7 +101,7 @@ USAGE
$ api login
```

_See code: [src/commands/login.ts](https://github.com/useoptic/optic-package/blob/v8.1.0/src/commands/login.ts)_
_See code: [src/commands/login.ts](https://github.com/useoptic/optic-package/blob/v8.2.9/src/commands/login.ts)_

## `api logout`

Expand All @@ -112,7 +112,7 @@ USAGE
$ api logout
```

_See code: [src/commands/logout.ts](https://github.com/useoptic/optic-package/blob/v8.1.0/src/commands/logout.ts)_
_See code: [src/commands/logout.ts](https://github.com/useoptic/optic-package/blob/v8.2.9/src/commands/logout.ts)_

## `api run [TASKNAME]`

Expand All @@ -123,7 +123,7 @@ USAGE
$ api run [TASKNAME]
```

_See code: [src/commands/run.ts](https://github.com/useoptic/optic-package/blob/v8.1.0/src/commands/run.ts)_
_See code: [src/commands/run.ts](https://github.com/useoptic/optic-package/blob/v8.2.9/src/commands/run.ts)_

## `api spec`

Expand All @@ -134,7 +134,7 @@ USAGE
$ api spec
```

_See code: [src/commands/spec.ts](https://github.com/useoptic/optic-package/blob/v8.1.0/src/commands/spec.ts)_
_See code: [src/commands/spec.ts](https://github.com/useoptic/optic-package/blob/v8.2.9/src/commands/spec.ts)_

## `api start`

Expand All @@ -145,5 +145,5 @@ USAGE
$ api start
```

_See code: [src/commands/start.ts](https://github.com/useoptic/optic-package/blob/v8.1.0/src/commands/start.ts)_
_See code: [src/commands/start.ts](https://github.com/useoptic/optic-package/blob/v8.2.9/src/commands/start.ts)_
<!-- commandsstop -->
12 changes: 6 additions & 6 deletions workspaces/local-cli/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@useoptic/cli",
"description": "The Optic CLI",
"version": "8.2.8",
"version": "8.2.9",
"author": "@useoptic",
"bin": {
"api": "./bin/run"
Expand All @@ -16,11 +16,11 @@
"@oclif/command": "^1",
"@oclif/config": "^1",
"@oclif/plugin-help": "^2",
"@useoptic/cli-client": "8.2.8",
"@useoptic/cli-config": "8.2.8",
"@useoptic/cli-scripts": "8.2.8",
"@useoptic/cli-server": "8.2.8",
"@useoptic/cli-shared": "8.2.8",
"@useoptic/cli-client": "8.2.9",
"@useoptic/cli-config": "8.2.9",
"@useoptic/cli-scripts": "8.2.9",
"@useoptic/cli-server": "8.2.9",
"@useoptic/cli-shared": "8.2.9",
"@useoptic/domain": "10.0.3",
"analytics-node": "^3.4.0-beta.1",
"cli-ux": "^5.4.1",
Expand Down
2 changes: 1 addition & 1 deletion workspaces/saas-types/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@useoptic/saas-types",
"description": "interfaces and types for Optic SaaS surface area",
"version": "8.2.8",
"version": "8.2.9",
"main": "build/index.js",
"files": [
"build"
Expand Down
2 changes: 1 addition & 1 deletion workspaces/snapshot-tests/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@useoptic/snapshot-tests",
"version": "8.2.8",
"version": "8.2.9",
"scripts": {
"ws:build": "yarn run tsc -b --verbose",
"ws:clean": "rm -rf build/*",
Expand Down
4 changes: 2 additions & 2 deletions workspaces/ui/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@useoptic/ui",
"version": "8.2.8",
"version": "8.2.9",
"files": [
"build",
"index.js",
Expand All @@ -15,7 +15,7 @@
"@material-ui/core": "^4.9.7",
"@material-ui/icons": "^4.9.1",
"@material-ui/lab": "^4.0.0-alpha.46",
"@useoptic/cli-client": "8.2.8",
"@useoptic/cli-client": "8.2.9",
"@useoptic/domain": "10.0.3",
"@useoptic/domain-utilities": "10.0.3",
"bottleneck": "^2.19.5",
Expand Down