Skip to main content

Lumar CLI

warning

This is a beta feature. If you would like to participate in the beta, please contact your account manager or support.

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

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.

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

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

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>] [--metricsTypePath
    <value>] [--metricsTypeName <value>] [--metricsTypeNames <value>] [--paramsTypePath <value>] [--paramsTypeName
    <value>] [--externalPackages <value>]

FLAGS
  --dirty                        Allow building in a non-empty directory
  --entrypoint=<value>           path to the TypeScript file with handler export
  --externalPackages=<value>...  external packages to include in the bundle
  --handler=<value>              name of the handler function exported from entrypoint
  --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
  --outDir=<value>               [default: dc.out/build/] Output directory for the build
  --paramsTypeName=<value>       name of the interface/type with input params definitions
  --paramsTypePath=<value>       path to the TypeScript file with the input params type export. if missing, entrypoint
                                 path will be used

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

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

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

link existing CustomMetricContainer with a Project

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

FLAGS
  --accountId=<value>
  --containerId=<value>  ID of the CustomMetricContainer that you want to link with a Project
  --multi                Link CustomMetricContainer to multiple Projects
  --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

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

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>] [--allowedRenderingResources Font|Image|TextTrack]
    [--navigationTimeoutMs <value>] [--viewportHeight <value>] [--viewportWidthDesktop <value>] [--viewportWidthMobile
    <value>]

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

FLAGS
  --allowedRenderingResources=<option>...  <options: Font|Image|TextTrack>
  --id=<value>                             ID of the CustomMetricContainer that you want to update
  --navigationTimeoutMs=<value>
  --viewportHeight=<value>
  --viewportWidthDesktop=<value>
  --viewportWidthMobile=<value>

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

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

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>] [--allowedRenderingResources Font|Image|TextTrack]
    [--navigationTimeoutMs <value>] [--viewportHeight <value>] [--viewportWidthDesktop <value>] [--viewportWidthMobile
    <value>]

ARGUMENTS
  PATH  path to zip that you want to publish

FLAGS
  --allowedRenderingResources=<option>...  <options: Font|Image|TextTrack>
  --id=<value>                             ID of the CustomMetricContainer that you want to update
  --navigationTimeoutMs=<value>
  --viewportHeight=<value>
  --viewportWidthDesktop=<value>
  --viewportWidthMobile=<value>

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

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

unlink CustomMetricContainer from Project

USAGE
  $ oreo metric unlink [--accountId <value>] [--containerId <value>] [--projectId <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

DESCRIPTION
  unlink CustomMetricContainer from Project

EXAMPLES
  $ oreo metric unlink

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

oreo project request-custom-metrics​

Run a request against a project.

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

FLAGS
  --customMetricContainerIds=<value>...
  --projectId=<value>                    (required) The project ID from which all the settings will be inherited.
  --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

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