@deepcrawl/oreo

v2.14.0

Published

7 days ago

deepcrawl cli

Downloads

504

0High
0Medium
0Low

deepcrawl-tech

karolisdeepcrawl

oreo deepcrawl crawler metrics

Oreo

✨ 🤖 🐱 the CLI for Lumar

Usage

$ npx @deepcrawl/oreo@latest COMMAND

Commands

`oreo crawl create`

Run Crawl in a Project

USAGE
  $ oreo crawl create [--accountId <value>] [--projectId <value>]

FLAGS
  --accountId=<value>  Account ID to create the Project in
  --projectId=<value>  ID of the Project to run Crawl in

DESCRIPTION
  Run Crawl in a Project

EXAMPLES
  $ oreo crawl create

See code: src/commands/crawl/create/index.ts

`oreo help [COMMAND]`

Display help for oreo.

USAGE
  $ oreo help [COMMAND...] [-n]

ARGUMENTS
  [COMMAND...]  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for oreo.

See code: @oclif/plugin-help

`oreo login`

Authenticate oreo with Lumar

USAGE
  $ oreo login [--accountId <value>] [--oauth | [--id <value> --secret <value>] | ]

FLAGS
  --accountId=<value>
  --id=<value>
  --oauth
  --secret=<value>

DESCRIPTION
  Authenticate oreo with Lumar

EXAMPLES
  $ oreo login

See code: src/commands/login/index.ts

`oreo metric bootstrap PATH`

Bootstraps a new CustomMetricContainer project. Generates boilerplate TypeScript project and registers CustomMetricContainer with API.

USAGE
  $ oreo metric bootstrap PATH [--accountId <value>] [--name <value>] [--description <value>] [--resourceTypes
    Document|Image|Script|Stylesheet...] [--inputType DOM|Puppeteer] [--dirty]

ARGUMENTS
  PATH  path to the new CustomMetricContainer project (empty folder)

FLAGS
  --accountId=<value>          Account ID to create the CustomMetricContainer in
  --description=<value>        Description of the new CustomMetricContainer
  --dirty                      Allow building in a non-empty directory
  --inputType=<option>         Which input type the CustomMetricContainer uses to extract metrics from the source types
                               <options: DOM|Puppeteer>
  --name=<value>               Name of the new CustomMetricContainer
  --resourceTypes=<option>...  Which source types the CustomMetricContainer extracts metrics from
                               <options: Document|Image|Script|Stylesheet>

DESCRIPTION
  Bootstraps a new CustomMetricContainer project. Generates boilerplate TypeScript project and registers
  CustomMetricContainer with API.

EXAMPLES
  $ oreo metric bootstrap my-metrics/ --name MyMetricName

See code: src/commands/metric/bootstrap/index.ts

`oreo metric build`

Build a CustomMetricContainer. Bundles TypeScript using esbuild and generates JSON schemas

USAGE
  $ oreo metric build [--outDir <value>] [--dirty] [--entrypoint <value>] [--handler <value>] [--metricsSchema
    <value>]

FLAGS
  --dirty                  Allow building in a non-empty directory
  --entrypoint=<value>     path to the JavaScript or TypeScript file with handler export
  --handler=<value>        name of the handler function exported from entrypoint
  --metricsSchema=<value>  path to JSON schema file for the output of handler function
  --outDir=<value>         [default: dc.out/build/] Output directory for the build

DESCRIPTION
  Build a CustomMetricContainer. Bundles TypeScript using esbuild and generates JSON schemas

EXAMPLES
  $ oreo metric build --outDir dc.out/build/

See code: src/commands/metric/build/index.ts

`oreo metric create`

create a new CustommetricContainer in the account

USAGE
  $ oreo metric create [--accountId <value>] [--name <value>] [--description <value>] [--resourceTypes
    Document|Image|Script|Stylesheet...] [--inputType DOM|Puppeteer]

FLAGS
  --accountId=<value>
  --description=<value>        Description of the new CustomMetricContainer
  --inputType=<option>         Which input type the CustomMetricContainer uses to extract metrics from the source types
                               <options: DOM|Puppeteer>
  --name=<value>               Name of the new CustomMetricContainer
  --resourceTypes=<option>...  Which source types the CustomMetricContainer extracts metrics from
                               <options: Document|Image|Script|Stylesheet>

DESCRIPTION
  create a new CustommetricContainer in the account

EXAMPLES
  $ oreo metric create --name MyMetricContainer --resourceTypes Document Image

See code: src/commands/metric/create.ts

`oreo metric generate-config-schema`

Generate a JSON schema for the container config

USAGE
  $ oreo metric generate-config-schema

DESCRIPTION
  Generate a JSON schema for the container config

EXAMPLES
  $ oreo metric generate-config-schema

See code: src/commands/metric/generate-config-schema/index.ts

`oreo metric global-secret set`

Set a secret for a CustomMetricContainer that will be inherited by all Projects using this container.

USAGE
  $ oreo metric global-secret set --name <value> --value <value> [--containerId <value>]

FLAGS
  --containerId=<value>  ID of the CustomMetricContainer that you want to set a secret for
  --name=<value>         (required) Secret name. (Will be available via Environment variables in the container.)
  --value=<value>        (required) Secret value

DESCRIPTION
  Set a secret for a CustomMetricContainer that will be inherited by all Projects using this container.

EXAMPLES
  $ oreo metric global-secret set --name SECRET_NAME --value SECRET_VALUE

See code: src/commands/metric/global-secret/set.ts

`oreo metric global-secret set-from-dotenv`

Reads all secrets in .env and sets secrets for a CustomMetricContainer that will be inherited by all Projects using this container.

USAGE
  $ oreo metric global-secret set-from-dotenv [--containerId <value>] [--dotenvPath <value>] [-y]

FLAGS
  -y, --yes                  Skip all prompts and use the default values
      --containerId=<value>  ID of the CustomMetricContainer that you want to set a secret for
      --dotenvPath=<value>   [default: .env] Path to the .env file

DESCRIPTION
  Reads all secrets in .env and sets secrets for a CustomMetricContainer that will be inherited by all Projects using
  this container.

EXAMPLES
  $ oreo metric global-secret set-from-dotenv

See code: src/commands/metric/global-secret/set-from-dotenv.ts

`oreo metric link`

link existing CustomMetricContainer with a Project

USAGE
  $ oreo metric link [--accountId <value>] [--containerId <value>] [--projectId <value>] [--projectIds <value>...]

FLAGS
  --accountId=<value>
  --containerId=<value>    ID of the CustomMetricContainer that you want to link with a Project
  --projectId=<value>      ID of the Project that you want to link CustomMetricContainer to
  --projectIds=<value>...  IDs of the Projects that you want to link CustomMetricContainer to

DESCRIPTION
  link existing CustomMetricContainer with a Project

EXAMPLES
  $ oreo metric link

See code: src/commands/metric/link.ts

`oreo metric local-test`

Runs tests for custom metric container

USAGE
  $ oreo metric local-test [--updateResults] [--entrypoint <value>] [--metricsTypePath <value>] [--metricsTypeName
    <value>] [--metricsTypeNames <value>]

FLAGS
  --entrypoint=<value>        path to the TypeScript file with handler export
  --metricsTypeName=<value>   name of the interface/type with metrics definitions. if missing, output types will be
                              generated from TypeScript
  --metricsTypeNames=<value>  JSON with multitype metric mapping, e.g '{"metricName": "MetricType" }'. if missing,
                              output types will be generated from TypeScript
  --metricsTypePath=<value>   path to the TypeScript file with the metrics type export. if missing, entrypoint path will
                              be used
  --updateResults             updates expected results file with new results

DESCRIPTION
  Runs tests for custom metric container

EXAMPLES
  $ oreo metric local-test

See code: src/commands/metric/local-test/index.ts

`oreo metric publish-dir PATH`

Publish a CustomMetricContainer bundle directory as a .zip file and publish it to the API.

USAGE
  $ oreo metric publish-dir PATH [--id <value>]

ARGUMENTS
  PATH  [default: dc.out/build/] path to directory that you want to publish

FLAGS
  --id=<value>  ID of the CustomMetricContainer that you want to update

DESCRIPTION
  Publish a CustomMetricContainer bundle directory as a .zip file and publish it to the API.

EXAMPLES
  $ oreo metric publish-dir dc.out/build/

See code: src/commands/metric/publish-dir/index.ts

`oreo metric publish-zip PATH`

Publish a CustomMetricContainer .zip file and publish it to the API. This command will create a new version of the CustomMetricContainer.

USAGE
  $ oreo metric publish-zip PATH [--id <value>]

ARGUMENTS
  PATH  path to zip that you want to publish

FLAGS
  --id=<value>  ID of the CustomMetricContainer that you want to update

DESCRIPTION
  Publish a CustomMetricContainer .zip file and publish it to the API. This command will create a new version of the
  CustomMetricContainer.

EXAMPLES
  $ oreo metric publish-zip dc.out/my-container.zip

See code: src/commands/metric/publish-zip/index.ts

`oreo metric secret set`

Set a secret for a CustomMetricContainerProject.

USAGE
  $ oreo metric secret set --projectId <value> --name <value> --value <value> [--containerId <value>]

FLAGS
  --containerId=<value>  ID of the CustomMetricContainer that you want to set a secret for
  --name=<value>         (required) Secret name. (Will be available via Environment variables in the container.)
  --projectId=<value>    (required) ID of the Project that you want to set a secret for
  --value=<value>        (required) Secret value

DESCRIPTION
  Set a secret for a CustomMetricContainerProject.

EXAMPLES
  $ oreo metric secret set --projectId 282970 --name SECRET_NAME --value SECRET_VALUE

See code: src/commands/metric/secret/set.ts

`oreo metric secret set-from-dotenv`

Reads all secrets in .env and sets secrets for a specific Project using a CustomMetricContainer.

USAGE
  $ oreo metric secret set-from-dotenv --projectId <value> [--containerId <value>] [--dotenvPath <value>] [-y]

FLAGS
  -y, --yes                  Skip all prompts and use the default values
      --containerId=<value>  ID of the CustomMetricContainer that you want to set a secret for
      --dotenvPath=<value>   [default: .env] Path to the .env file
      --projectId=<value>    (required) ID of the Project that you want to set a secret for

DESCRIPTION
  Reads all secrets in .env and sets secrets for a specific Project using a CustomMetricContainer.

EXAMPLES
  $ oreo metric secret set-from-dotenv --projectId 282970

See code: src/commands/metric/secret/set-from-dotenv.ts

`oreo metric unlink`

unlink CustomMetricContainer from Project

USAGE
  $ oreo metric unlink --containerId <value> --projectId <value>

FLAGS
  --containerId=<value>  (required) ID of the CustomMetricContainer that you want to link with a Project
  --projectId=<value>    (required) ID of the Project that you want to link CustomMetricContainer to

DESCRIPTION
  unlink CustomMetricContainer from Project

EXAMPLES
  $ oreo metric unlink

See code: src/commands/metric/unlink.ts

`oreo project create`

USAGE
  $ oreo project create [--accountId <value>] [--name <value>] [--domain <value>] [--type
    Accessibility|Basic|SEO|SiteSpeed] [--useRenderer] [--receiveAlertEmails]

FLAGS
  --accountId=<value>   Account ID to create the Project in
  --domain=<value>      Primary domain of the new Project
  --name=<value>        Name of the new Project
  --receiveAlertEmails  Receive alert emails for the new Project
  --type=<option>       Type of the new Project
                        <options: Accessibility|Basic|SEO|SiteSpeed>
  --useRenderer         Use JS renderer for the new Project

EXAMPLES
  $ oreo project create --name "Test Oreo Project" --domain http://example.com

See code: src/commands/project/create/index.ts

`oreo project request-custom-metrics`

Run a request against a project.

USAGE
  $ oreo project request-custom-metrics --projectId <value> --url <value> [--json] [--customMetricContainerIds <value>...]
    [--saveHtml <value>]

FLAGS
  --customMetricContainerIds=<value>...
  --projectId=<value>                    (required) The project ID from which all the settings will be inherited.
  --saveHtml=<value>                     The file to write the renderedBody to.
  --url=<value>                          (required) The URL to request.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Run a request against a project.

EXAMPLES
  $ oreo project request-custom-metrics --projectId 282970 --url https://www.example.com/

  $ oreo project request-custom-metrics --projectId 282970 --url https://www.example.com/ --customMetricContainerIds 1,2

  $ oreo project request-custom-metrics --projectId 282970 --url https://www.example.com/ --customMetricContainerIds 44 --json

See code: src/commands/project/request-custom-metrics/index.ts

`oreo user-key create`

Create a new UserKey

USAGE
  $ oreo user-key create [--json] [--name <value>]

FLAGS
  --name=<value>  Name of the new UserKey

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Create a new UserKey

See code: src/commands/user-key/create/index.ts

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

Oreo

Usage

Commands

oreo crawl create

oreo help [COMMAND]

oreo login

oreo metric bootstrap PATH

oreo metric build

oreo metric create

oreo metric generate-config-schema

oreo metric global-secret set

oreo metric global-secret set-from-dotenv

oreo metric link

oreo metric local-test

oreo metric publish-dir PATH

oreo metric publish-zip PATH

oreo metric secret set

oreo metric secret set-from-dotenv

oreo metric unlink

oreo project create

oreo project request-custom-metrics

oreo user-key create