@vertexvis/cli

v0.18.5

Published

2 months ago

The Vertex platform command-line interface (CLI).

Downloads

0High
0Medium
0Low

Vertex CLI

TypeDoc Documentation

The Vertex command-line interface (CLI) makes Vertex API calls on your behalf, simplifying common operations into single commands.

To get started with the CLI, check out our guide. Below, find installation and configuration instructions along with a full list of commands and their options.

Install the CLI, npm install -g @vertexvis/cli. Next, run vertex configure with the optional --basePath option to configure your Vertex client ID and secret. This creates ~/.config/@vertexvis/cli/config.json on macOs/Linux and %LOCALAPPDATA%\@vertexvis/cli/config.json on Windows with your credentials. Then, run the other commands with the same --basePath option and the CLI will use the proper credentials to communicate with Vertex's API.

Local development

The CLI uses oclif framework. It's a thin layer on top of @vertexvis/api-client-node. This means that for most changes, you'll be making modifications to both libraries. To link them, clone both repositories, then,

In vertex-api-client-node,
Install dependencies, yarn install
Build the project, yarn clean-build
Link it, yarn link
In vertex-cli,
Reference the linked client, yarn link @vertexvis/api-client-node
Run the local version of the CLI, ./bin/run --help

When you're ready to publish a new version, commit your changes and then run yarn version [--patch | --minor | --major]. oclif takes care of updating the version numbers and updating the README.

Usage

$ npm install -g @vertexvis/cli
$ vertex COMMAND
running command...
$ vertex (-v|--version|version)
@vertexvis/cli/0.18.5 linux-x64 node-v18.20.4
$ vertex --help [COMMAND]
USAGE
  $ vertex COMMAND
...

Commands

`vertex configure`

Configure Vertex credentials.

USAGE
  $ vertex configure

OPTIONS
  -b, --basePath=basePath  [default: https://platform.vertexvis.com] Vertex API base path.
  -h, --help               show CLI help
  -v, --verbose

EXAMPLE
  $ vertex configure
  Saved 'https://platform.vertexvis.com' configuration to '~/.config/@vertexvis/cli/config.json'.

See code: src/commands/configure.ts

`vertex create-items [PATH]`

Calculate path IDs and transforms for each instance in file and output JSON file containing SceneItems (as defined in src/create-items/index.d.ts).

USAGE
  $ vertex create-items [PATH]

OPTIONS
  -b, --basePath=basePath                  [default: https://platform.vertexvis.com] Vertex API base path.
  -f, --format=pvs                         (required) File format.
  -h, --help                               show CLI help
  -o, --output=output                      [default: items.json] Path to output file.

  -r, --revisionProperty=revisionProperty  Assuming the file format includes metadata properties, the property name to
                                           use for the part-revision's supplied ID. If not provided, the supplied ID
                                           defaults to '1'.

  -v, --verbose

  --root=root                              Part/assembly to use as root in file.

EXAMPLE
  $ vertex create-items --format pvs [YOUR_PATH_TO_XML_FILE]
  Wrote 5 pvs item(s) from '[YOUR_PATH_TO_XML_FILE]' to 'items.json'.

See code: src/commands/create-items.ts

`vertex create-parts [PATH]`

Given JSON file containing SceneItems (as defined in src/create-items/index.d.ts), upload geometry files and create parts in Vertex Part Library.

USAGE
  $ vertex create-parts [PATH]

OPTIONS
  -b, --backoff                          Whether use a backoff to the pollInterval for longer queued jobs.
  -b, --basePath=basePath                [default: https://platform.vertexvis.com] Vertex API base path.
  -d, --directory=directory              Directory containing geometry files.
  -h, --help                             show CLI help
  -m, --maxPollDuration=maxPollDuration  [default: 3600] The maximum poll duration in seconds for queued jobs.
  -p, --parallelism=parallelism          [default: 20] Number of files and parts to create in parallel.
  -v, --verbose

EXAMPLE
  $ vertex create-parts --directory [YOUR_PATH_TO_GEOMETRY_DIRECTORY] [YOUR_PATH_TO_JSON_FILE]
    ████████████████████████████████████████ 100% | 10/10

See code: src/commands/create-parts.ts

`vertex create-scene [PATH]`

Given JSON file containing SceneItems (as defined in src/create-items/index.d.ts), create scene in Vertex.

USAGE
  $ vertex create-scene [PATH]

OPTIONS
  -b, --backoff                                                    Whether use a backoff to the pollInterval for longer
                                                                   queued jobs.

  -b, --basePath=basePath                                          [default: https://platform.vertexvis.com] Vertex API
                                                                   base path.

  -h, --help                                                       show CLI help

  -m, --maxPollDuration=maxPollDuration                            [default: 3600] The maximum poll duration in seconds
                                                                   for queued jobs.

  -p, --parallelism=parallelism                                    [default: 20] Number of scene-items to create in
                                                                   parallel.

  -v, --verbose

  --experimentalSourceMetadataKeys=experimentalSourceMetadataKeys  comma-separated list of items

  --name=name                                                      Name of scene.

  --noFailFast                                                     Whether or not to fail the process immediately if any
                                                                   scene item creation fails.

  --suppliedId=suppliedId                                          SuppliedId of scene.

  --treeEnabled                                                    Whether or not scene trees should be enabled for this
                                                                   scene.

  --validate                                                       Whether or not to validate the creation of every
                                                                   scene item.

EXAMPLE
  $ vertex create-scene --name my-scene [YOUR_PATH_TO_JSON_FILE]
    ████████████████████████████████████████ 100% | 10/10
  f79d4760-0b71-44e4-ad0b-22743fdd4ca3

See code: src/commands/create-scene.ts

`vertex exports:create`

Create an export for a scene.

USAGE
  $ vertex exports:create

OPTIONS
  -b, --basePath=basePath  [default: https://platform.vertexvis.com] Vertex API base path.
  -h, --help               show CLI help
  -v, --verbose
  --format=format          (required) Type of file to export. Currently supports 'step' and 'jt'
  --sceneId=sceneId        (required) Scene to export.

EXAMPLE
  $ vertex exports:create --sceneId f79d4760-0b71-44e4-ad0b-22743fdd4ca3 --format jt
  bf0c4343-96eb-4aa9-8dee-e79c6458dedf

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

`vertex exports:download ID`

Download an export.

USAGE
  $ vertex exports:download ID

OPTIONS
  -b, --basePath=basePath  [default: https://platform.vertexvis.com] Vertex API base path.
  -h, --help               show CLI help
  -v, --verbose
  --extended               Display extended output.

EXAMPLE
  $ vertex exports:download 54964c61-05d8-4f37-9638-18f7c4960c80
  Export saved as: 54964c61-05d8-4f37-9638-18f7c4960c80

See code: src/commands/exports/download.ts

`vertex exports:get ID`

Get an export.

USAGE
  $ vertex exports:get ID

OPTIONS
  -b, --basePath=basePath  [default: https://platform.vertexvis.com] Vertex API base path.
  -h, --help               show CLI help
  -v, --verbose
  --extended               Display extended output.

EXAMPLE
  $ vertex exports:get 54964c61-05d8-4f37-9638-18f7c4960c80
  Id                                   DownloadUrl
  54964c61-05d8-4f37-9638-18f7c4960c80 https://some-url.com/some-file

See code: src/commands/exports/get.ts

`vertex files:delete [ID]`

Delete files.

USAGE
  $ vertex files:delete [ID]

OPTIONS
  -b, --basePath=basePath  [default: https://platform.vertexvis.com] Vertex API base path.
  -h, --help               show CLI help
  -v, --verbose
  --all                    Delete all resources.

EXAMPLE
  $ vertex files:delete 54964c61-05d8-4f37-9638-18f7c4960c80
  Deleted file 54964c61-05d8-4f37-9638-18f7c4960c80.
  Deleting file(s)...... done

See code: src/commands/files/delete.ts

`vertex files:get ID`

Get a file.

USAGE
  $ vertex files:get ID

OPTIONS
  -b, --basePath=basePath  [default: https://platform.vertexvis.com] Vertex API base path.
  -h, --help               show CLI help
  -v, --verbose
  --extended               Display extended output.

EXAMPLE
  $ vertex files:get 54964c61-05d8-4f37-9638-18f7c4960c80
  Id                                   Name
  54964c61-05d8-4f37-9638-18f7c4960c80 my-file

See code: src/commands/files/get.ts

`vertex files:list`

Get files.

USAGE
  $ vertex files:list

OPTIONS
  -b, --basePath=basePath  [default: https://platform.vertexvis.com] Vertex API base path.
  -h, --help               show CLI help
  -v, --verbose
  --cursor=cursor          Cursor for next page of items.
  --extended               Display extended output.

EXAMPLE
  $ vertex files:list
  Id                                   Name
  54964c61-05d8-4f37-9638-18f7c4960c80 my-file-1
  a8070713-e48e-466b-b4bb-b3132895d5ce my-file-2

See code: src/commands/files/list.ts

`vertex help [COMMAND]`

display help for vertex

USAGE
  $ vertex help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

`vertex part-revisions:render ID`

Render a part revision.

USAGE
  $ vertex part-revisions:render ID

OPTIONS
  -b, --basePath=basePath  [default: https://platform.vertexvis.com] Vertex API base path.
  -h, --height=height      [default: 100] Image height.
  -h, --help               show CLI help
  -o, --output=output      Path to output file.
  -v, --verbose
  -w, --width=width        [default: 100] Image width.

EXAMPLE
  $ vertex part-revisions:render 54964c61-05d8-4f37-9638-18f7c4960c80
  54964c61-05d8-4f37-9638-18f7c4960c80.jpg

See code: src/commands/part-revisions/render.ts

`vertex parts:delete [ID]`

Delete parts.

USAGE
  $ vertex parts:delete [ID]

OPTIONS
  -b, --basePath=basePath  [default: https://platform.vertexvis.com] Vertex API base path.
  -h, --help               show CLI help
  -v, --verbose
  --all                    Delete all resources.

EXAMPLE
  $ vertex parts:delete 54964c61-05d8-4f37-9638-18f7c4960c80
  Deleted part 54964c61-05d8-4f37-9638-18f7c4960c80.
  Deleting part(s)...... done

See code: src/commands/parts/delete.ts

`vertex parts:get ID`

Get a part.

USAGE
  $ vertex parts:get ID

OPTIONS
  -b, --basePath=basePath  [default: https://platform.vertexvis.com] Vertex API base path.
  -h, --help               show CLI help
  -v, --verbose
  --extended               Display extended output.

EXAMPLE
  $ vertex parts:get 54964c61-05d8-4f37-9638-18f7c4960c80
  Id                                   Name
  54964c61-05d8-4f37-9638-18f7c4960c80 my-part

See code: src/commands/parts/get.ts

`vertex parts:list`

Get parts.

USAGE
  $ vertex parts:list

OPTIONS
  -b, --basePath=basePath  [default: https://platform.vertexvis.com] Vertex API base path.
  -h, --help               show CLI help
  -v, --verbose
  --cursor=cursor          Cursor for next page of items.
  --extended               Display extended output.

EXAMPLE
  $ vertex parts:list
  Id                                   Name
  54964c61-05d8-4f37-9638-18f7c4960c80 my-part-1
  a8070713-e48e-466b-b4bb-b3132895d5ce my-part-2

See code: src/commands/parts/list.ts

`vertex scene-items:get ID`

Get a scene item.

USAGE
  $ vertex scene-items:get ID

OPTIONS
  -b, --basePath=basePath  [default: https://platform.vertexvis.com] Vertex API base path.
  -h, --help               show CLI help
  -v, --verbose
  --extended               Display extended output.

EXAMPLE
  $ vertex scene-items:get 54964c61-05d8-4f37-9638-18f7c4960c80
  Id                                   Name
  54964c61-05d8-4f37-9638-18f7c4960c80 my-scene-item

See code: src/commands/scene-items/get.ts

`vertex scene-items:list`

Get scene items.

USAGE
  $ vertex scene-items:list

OPTIONS
  -b, --basePath=basePath  [default: https://platform.vertexvis.com] Vertex API base path.
  -h, --help               show CLI help
  -v, --verbose
  --cursor=cursor          Cursor for next page of items.
  --extended               Display extended output.
  --sceneId=sceneId        (required) Scene to list scene items.

EXAMPLE
  $ vertex scene-items:list
  Id                                   Name
  54964c61-05d8-4f37-9638-18f7c4960c80 my-scene-item-1
  a8070713-e48e-466b-b4bb-b3132895d5ce my-scene-item-2

See code: src/commands/scene-items/list.ts

`vertex scene-view-states:delete [ID]`

Delete scene-view-states.

USAGE
  $ vertex scene-view-states:delete [ID]

OPTIONS
  -b, --basePath=basePath  [default: https://platform.vertexvis.com] Vertex API base path.
  -h, --help               show CLI help
  -v, --verbose
  --all                    Delete all resources.

EXAMPLE
  $ vertex scene-view-states:delete 54964c61-05d8-4f37-9638-18f7c4960c80
  Deleted scene view state 54964c61-05d8-4f37-9638-18f7c4960c80.
  Deleting scene view state(s)...... done

See code: src/commands/scene-view-states/delete.ts

`vertex scene-view-states:get ID`

Get a scene-view-state.

USAGE
  $ vertex scene-view-states:get ID

OPTIONS
  -b, --basePath=basePath  [default: https://platform.vertexvis.com] Vertex API base path.
  -h, --help               show CLI help
  -v, --verbose
  --extended               Display extended output.

EXAMPLE
  $ vertex scene-view-states:get 54964c61-05d8-4f37-9638-18f7c4960c80
  Id                                   Name
  54964c61-05d8-4f37-9638-18f7c4960c80 my-scene-view-state

See code: src/commands/scene-view-states/get.ts

`vertex scene-view-states:list`

Get scene-view-states.

USAGE
  $ vertex scene-view-states:list

OPTIONS
  -b, --basePath=basePath  [default: https://platform.vertexvis.com] Vertex API base path.
  -h, --help               show CLI help
  -v, --verbose
  --cursor=cursor          Cursor for next page of items.
  --extended               Display extended output.
  --sceneId=sceneId        (required) Scene to list scene view states.

EXAMPLE
  $ vertex scene-view-states:list
  Id                                   Name
  54964c61-05d8-4f37-9638-18f7c4960c80 my-scene-view-state-1
  a8070713-e48e-466b-b4bb-b3132895d5ce my-scene-view-state-2

See code: src/commands/scene-view-states/list.ts

`vertex scene-views:create`

Create a scene view for a scene.

USAGE
  $ vertex scene-views:create

OPTIONS
  -b, --basePath=basePath  [default: https://platform.vertexvis.com] Vertex API base path.
  -h, --help               show CLI help
  -v, --verbose
  --sceneId=sceneId        (required) Scene to base scene view on.

EXAMPLE
  $ vertex scene-views:create --sceneId f79d4760-0b71-44e4-ad0b-22743fdd4ca3
  bf0c4343-96eb-4aa9-8dee-e79c6458dedf

See code: src/commands/scene-views/create.ts

`vertex scene-views:get ID`

Get a scene view.

USAGE
  $ vertex scene-views:get ID

OPTIONS
  -b, --basePath=basePath  [default: https://platform.vertexvis.com] Vertex API base path.
  -h, --help               show CLI help
  -v, --verbose
  --extended               Display extended output.

EXAMPLE
  $ vertex scene-views:get 54964c61-05d8-4f37-9638-18f7c4960c80
  Id                                   Name
  54964c61-05d8-4f37-9638-18f7c4960c80 my-scene-view

See code: src/commands/scene-views/get.ts

`vertex scene-views:list`

Get scene views.

USAGE
  $ vertex scene-views:list

OPTIONS
  -b, --basePath=basePath  [default: https://platform.vertexvis.com] Vertex API base path.
  -h, --help               show CLI help
  -v, --verbose
  --cursor=cursor          Cursor for next page of items.
  --extended               Display extended output.
  --sceneId=sceneId        (required) Scene to list scene views.

EXAMPLE
  $ vertex scene-views:list
  Id                                   Name
  54964c61-05d8-4f37-9638-18f7c4960c80 my-scene-view-1
  a8070713-e48e-466b-b4bb-b3132895d5ce my-scene-view-2

See code: src/commands/scene-views/list.ts

`vertex scene-views:render ID`

Render a scene view.

USAGE
  $ vertex scene-views:render ID

OPTIONS
  -b, --basePath=basePath  [default: https://platform.vertexvis.com] Vertex API base path.
  -h, --height=height      [default: 100] Image height.
  -h, --help               show CLI help
  -o, --output=output      Path to output file.
  -v, --verbose
  -w, --width=width        [default: 100] Image width.

EXAMPLE
  $ vertex scene-views:render 54964c61-05d8-4f37-9638-18f7c4960c80
  54964c61-05d8-4f37-9638-18f7c4960c80.jpg

See code: src/commands/scene-views/render.ts

`vertex scenes:delete [ID]`

Delete scenes.

USAGE
  $ vertex scenes:delete [ID]

OPTIONS
  -b, --basePath=basePath  [default: https://platform.vertexvis.com] Vertex API base path.
  -h, --help               show CLI help
  -v, --verbose
  --all                    Delete all resources.

EXAMPLE
  $ vertex scenes:delete 54964c61-05d8-4f37-9638-18f7c4960c80
  Deleted scene 54964c61-05d8-4f37-9638-18f7c4960c80.
  Deleting scene(s)...... done

See code: src/commands/scenes/delete.ts

`vertex scenes:get ID`

Get a scene.

USAGE
  $ vertex scenes:get ID

OPTIONS
  -b, --basePath=basePath  [default: https://platform.vertexvis.com] Vertex API base path.
  -h, --help               show CLI help
  -v, --verbose
  --extended               Display extended output.

EXAMPLE
  $ vertex scenes:get 54964c61-05d8-4f37-9638-18f7c4960c80
  Id                                   Name
  54964c61-05d8-4f37-9638-18f7c4960c80 my-scene

See code: src/commands/scenes/get.ts

`vertex scenes:list`

Get scenes.

USAGE
  $ vertex scenes:list

OPTIONS
  -b, --basePath=basePath  [default: https://platform.vertexvis.com] Vertex API base path.
  -h, --help               show CLI help
  -v, --verbose
  --cursor=cursor          Cursor for next page of items.
  --extended               Display extended output.

EXAMPLE
  $ vertex scenes:list
  Id                                   Name
  54964c61-05d8-4f37-9638-18f7c4960c80 my-scene-1
  a8070713-e48e-466b-b4bb-b3132895d5ce my-scene-2

See code: src/commands/scenes/list.ts

`vertex scenes:render ID`

Render a scene.

USAGE
  $ vertex scenes:render ID

OPTIONS
  -b, --basePath=basePath  [default: https://platform.vertexvis.com] Vertex API base path.
  -h, --height=height      [default: 100] Image height.
  -h, --help               show CLI help
  -o, --output=output      Path to output file.
  -v, --verbose
  -w, --width=width        [default: 100] Image width.
  --viewer                 Create Web SDK Viewer HTML instead of jpg image.

EXAMPLE
  $ vertex scenes:render 54964c61-05d8-4f37-9638-18f7c4960c80
  54964c61-05d8-4f37-9638-18f7c4960c80.jpg

See code: src/commands/scenes/render.ts

`vertex stream-keys:create`

Create a stream key for a scene.

USAGE
  $ vertex stream-keys:create

OPTIONS
  -b, --basePath=basePath  [default: https://platform.vertexvis.com] Vertex API base path.
  -h, --help               show CLI help
  -k, --expiry=expiry      [default: 600] Expiry in seconds to set on stream-key.
  -v, --verbose
  --sceneId=sceneId        (required) Scene to access with stream key.

EXAMPLE
  $ vertex stream-keys:create --sceneId f79d4760-0b71-44e4-ad0b-22743fdd4ca3
  hBXAoQdnsHVhgDZkxeLEPQVxPJ600QwDMdgq

See code: src/commands/stream-keys/create.ts

`vertex webhook-subscriptions:create`

Create a webhook subscription.

USAGE
  $ vertex webhook-subscriptions:create

OPTIONS
  -b, --basePath=basePath  [default: https://platform.vertexvis.com] Vertex API base path.
  -h, --help               show CLI help
  -v, --verbose
  --topics=topics          (required) Comma-separated list of topics.
  --url=url                (required) URL Vertex will POST webhook events.

EXAMPLE
  $ vertex webhook-subscriptions:create --topics queued-translation.completed,scene.updated --url https://example.com
  ta47eOIQtg13pSyf/PgpAB47r4JYJoAZfyzAcB5x8IHo+gQ

See code: src/commands/webhook-subscriptions/create.ts

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

Vertex CLI

Local development

Usage

Commands

vertex configure

vertex create-items [PATH]

vertex create-parts [PATH]

vertex create-scene [PATH]

vertex exports:create

vertex exports:download ID

vertex exports:get ID

vertex files:delete [ID]

vertex files:get ID

vertex files:list

vertex help [COMMAND]

vertex part-revisions:render ID

vertex parts:delete [ID]

vertex parts:get ID

vertex parts:list

vertex scene-items:get ID

vertex scene-items:list

vertex scene-view-states:delete [ID]

vertex scene-view-states:get ID

vertex scene-view-states:list

vertex scene-views:create

vertex scene-views:get ID

vertex scene-views:list

vertex scene-views:render ID

vertex scenes:delete [ID]

vertex scenes:get ID

vertex scenes:list

vertex scenes:render ID

vertex stream-keys:create

vertex webhook-subscriptions:create