Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
104 changes: 74 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ $ npm install -g @vertexvis/cli
$ vertex COMMAND
running command...
$ vertex (-v|--version|version)
@vertexvis/cli/0.18.5 darwin-x64 node-v18.16.0
@vertexvis/cli/0.19.0 darwin-arm64 node-v22.12.0
$ vertex --help [COMMAND]
USAGE
$ vertex COMMAND
Expand Down Expand Up @@ -67,6 +67,8 @@ USAGE
* [`vertex parts:list`](#vertex-partslist)
* [`vertex scene-items:get ID`](#vertex-scene-itemsget-id)
* [`vertex scene-items:list`](#vertex-scene-itemslist)
* [`vertex scene-trees:export SCENEID`](#vertex-scene-treesexport-sceneid)
* [`vertex scene-trees:view SCENEID`](#vertex-scene-treesview-sceneid)
* [`vertex scene-view-states:delete [ID]`](#vertex-scene-view-statesdelete-id)
* [`vertex scene-view-states:get ID`](#vertex-scene-view-statesget-id)
* [`vertex scene-view-states:list`](#vertex-scene-view-stateslist)
Expand Down Expand Up @@ -99,7 +101,7 @@ EXAMPLE
Saved 'https://platform.vertexvis.com' configuration to '~/.config/@vertexvis/cli/config.json'.
```

_See code: [src/commands/configure.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.18.5/src/commands/configure.ts)_
_See code: [src/commands/configure.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.19.0/src/commands/configure.ts)_

## `vertex create-items [PATH]`

Expand Down Expand Up @@ -128,7 +130,7 @@ EXAMPLE
Wrote 5 pvs item(s) from '[YOUR_PATH_TO_XML_FILE]' to 'items.json'.
```

_See code: [src/commands/create-items.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.18.5/src/commands/create-items.ts)_
_See code: [src/commands/create-items.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.19.0/src/commands/create-items.ts)_

## `vertex create-parts [PATH]`

Expand All @@ -152,7 +154,7 @@ EXAMPLE
████████████████████████████████████████ 100% | 10/10
```

_See code: [src/commands/create-parts.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.18.5/src/commands/create-parts.ts)_
_See code: [src/commands/create-parts.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.19.0/src/commands/create-parts.ts)_

## `vertex create-scene [PATH]`

Expand Down Expand Up @@ -200,7 +202,7 @@ EXAMPLE
f79d4760-0b71-44e4-ad0b-22743fdd4ca3
```

_See code: [src/commands/create-scene.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.18.5/src/commands/create-scene.ts)_
_See code: [src/commands/create-scene.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.19.0/src/commands/create-scene.ts)_

## `vertex exports:create`

Expand All @@ -222,7 +224,7 @@ EXAMPLE
bf0c4343-96eb-4aa9-8dee-e79c6458dedf
```

_See code: [src/commands/exports/create.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.18.5/src/commands/exports/create.ts)_
_See code: [src/commands/exports/create.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.19.0/src/commands/exports/create.ts)_

## `vertex exports:download ID`

Expand All @@ -243,7 +245,7 @@ EXAMPLE
Export saved as: 54964c61-05d8-4f37-9638-18f7c4960c80
```

_See code: [src/commands/exports/download.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.18.5/src/commands/exports/download.ts)_
_See code: [src/commands/exports/download.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.19.0/src/commands/exports/download.ts)_

## `vertex exports:get ID`

Expand All @@ -265,7 +267,7 @@ EXAMPLE
54964c61-05d8-4f37-9638-18f7c4960c80 https://some-url.com/some-file
```

_See code: [src/commands/exports/get.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.18.5/src/commands/exports/get.ts)_
_See code: [src/commands/exports/get.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.19.0/src/commands/exports/get.ts)_

## `vertex files:delete [ID]`

Expand All @@ -287,7 +289,7 @@ EXAMPLE
Deleting file(s)...... done
```

_See code: [src/commands/files/delete.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.18.5/src/commands/files/delete.ts)_
_See code: [src/commands/files/delete.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.19.0/src/commands/files/delete.ts)_

## `vertex files:get ID`

Expand All @@ -309,7 +311,7 @@ EXAMPLE
54964c61-05d8-4f37-9638-18f7c4960c80 my-file
```

_See code: [src/commands/files/get.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.18.5/src/commands/files/get.ts)_
_See code: [src/commands/files/get.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.19.0/src/commands/files/get.ts)_

## `vertex files:list`

Expand All @@ -333,7 +335,7 @@ EXAMPLE
a8070713-e48e-466b-b4bb-b3132895d5ce my-file-2
```

_See code: [src/commands/files/list.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.18.5/src/commands/files/list.ts)_
_See code: [src/commands/files/list.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.19.0/src/commands/files/list.ts)_

## `vertex help [COMMAND]`

Expand Down Expand Up @@ -373,7 +375,7 @@ EXAMPLE
54964c61-05d8-4f37-9638-18f7c4960c80.jpg
```

_See code: [src/commands/part-revisions/render.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.18.5/src/commands/part-revisions/render.ts)_
_See code: [src/commands/part-revisions/render.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.19.0/src/commands/part-revisions/render.ts)_

## `vertex parts:delete [ID]`

Expand All @@ -395,7 +397,7 @@ EXAMPLE
Deleting part(s)...... done
```

_See code: [src/commands/parts/delete.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.18.5/src/commands/parts/delete.ts)_
_See code: [src/commands/parts/delete.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.19.0/src/commands/parts/delete.ts)_

## `vertex parts:get ID`

Expand All @@ -417,7 +419,7 @@ EXAMPLE
54964c61-05d8-4f37-9638-18f7c4960c80 my-part
```

_See code: [src/commands/parts/get.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.18.5/src/commands/parts/get.ts)_
_See code: [src/commands/parts/get.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.19.0/src/commands/parts/get.ts)_

## `vertex parts:list`

Expand All @@ -441,7 +443,7 @@ EXAMPLE
a8070713-e48e-466b-b4bb-b3132895d5ce my-part-2
```

_See code: [src/commands/parts/list.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.18.5/src/commands/parts/list.ts)_
_See code: [src/commands/parts/list.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.19.0/src/commands/parts/list.ts)_

## `vertex scene-items:get ID`

Expand All @@ -463,7 +465,7 @@ EXAMPLE
54964c61-05d8-4f37-9638-18f7c4960c80 my-scene-item
```

_See code: [src/commands/scene-items/get.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.18.5/src/commands/scene-items/get.ts)_
_See code: [src/commands/scene-items/get.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.19.0/src/commands/scene-items/get.ts)_

## `vertex scene-items:list`

Expand All @@ -488,7 +490,49 @@ EXAMPLE
a8070713-e48e-466b-b4bb-b3132895d5ce my-scene-item-2
```

_See code: [src/commands/scene-items/list.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.18.5/src/commands/scene-items/list.ts)_
_See code: [src/commands/scene-items/list.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.19.0/src/commands/scene-items/list.ts)_

## `vertex scene-trees:export SCENEID`

Export a scene's scene item tree to a ZIP file.

```
USAGE
$ vertex scene-trees:export SCENEID

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

EXAMPLE
$ vertex scene-trees:export 54964c61-05d8-4f37-9638-18f7c4960c80
Tree saved to: 54964c61-05d8-4f37-9638-18f7c4960c80.zip
```

_See code: [src/commands/scene-trees/export.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.19.0/src/commands/scene-trees/export.ts)_

## `vertex scene-trees:view SCENEID`

View a scene's item tree.

```
USAGE
$ vertex scene-trees:view SCENEID

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

EXAMPLE
$ vertex scene-trees:view 54964c61-05d8-4f37-9638-18f7c4960c80
[TreeNode (root) has 3 child nodes, data=[...]]
└── [TreeNode has 2 child nodes, data=[...]]
```

_See code: [src/commands/scene-trees/view.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.19.0/src/commands/scene-trees/view.ts)_

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

Expand All @@ -510,7 +554,7 @@ EXAMPLE
Deleting scene view state(s)...... done
```

_See code: [src/commands/scene-view-states/delete.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.18.5/src/commands/scene-view-states/delete.ts)_
_See code: [src/commands/scene-view-states/delete.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.19.0/src/commands/scene-view-states/delete.ts)_

## `vertex scene-view-states:get ID`

Expand All @@ -532,7 +576,7 @@ EXAMPLE
54964c61-05d8-4f37-9638-18f7c4960c80 my-scene-view-state
```

_See code: [src/commands/scene-view-states/get.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.18.5/src/commands/scene-view-states/get.ts)_
_See code: [src/commands/scene-view-states/get.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.19.0/src/commands/scene-view-states/get.ts)_

## `vertex scene-view-states:list`

Expand All @@ -557,7 +601,7 @@ EXAMPLE
a8070713-e48e-466b-b4bb-b3132895d5ce my-scene-view-state-2
```

_See code: [src/commands/scene-view-states/list.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.18.5/src/commands/scene-view-states/list.ts)_
_See code: [src/commands/scene-view-states/list.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.19.0/src/commands/scene-view-states/list.ts)_

## `vertex scene-views:create`

Expand All @@ -578,7 +622,7 @@ EXAMPLE
bf0c4343-96eb-4aa9-8dee-e79c6458dedf
```

_See code: [src/commands/scene-views/create.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.18.5/src/commands/scene-views/create.ts)_
_See code: [src/commands/scene-views/create.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.19.0/src/commands/scene-views/create.ts)_

## `vertex scene-views:get ID`

Expand All @@ -600,7 +644,7 @@ EXAMPLE
54964c61-05d8-4f37-9638-18f7c4960c80 my-scene-view
```

_See code: [src/commands/scene-views/get.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.18.5/src/commands/scene-views/get.ts)_
_See code: [src/commands/scene-views/get.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.19.0/src/commands/scene-views/get.ts)_

## `vertex scene-views:list`

Expand All @@ -625,7 +669,7 @@ EXAMPLE
a8070713-e48e-466b-b4bb-b3132895d5ce my-scene-view-2
```

_See code: [src/commands/scene-views/list.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.18.5/src/commands/scene-views/list.ts)_
_See code: [src/commands/scene-views/list.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.19.0/src/commands/scene-views/list.ts)_

## `vertex scene-views:render ID`

Expand All @@ -648,7 +692,7 @@ EXAMPLE
54964c61-05d8-4f37-9638-18f7c4960c80.jpg
```

_See code: [src/commands/scene-views/render.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.18.5/src/commands/scene-views/render.ts)_
_See code: [src/commands/scene-views/render.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.19.0/src/commands/scene-views/render.ts)_

## `vertex scenes:delete [ID]`

Expand All @@ -670,7 +714,7 @@ EXAMPLE
Deleting scene(s)...... done
```

_See code: [src/commands/scenes/delete.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.18.5/src/commands/scenes/delete.ts)_
_See code: [src/commands/scenes/delete.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.19.0/src/commands/scenes/delete.ts)_

## `vertex scenes:get ID`

Expand All @@ -692,7 +736,7 @@ EXAMPLE
54964c61-05d8-4f37-9638-18f7c4960c80 my-scene
```

_See code: [src/commands/scenes/get.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.18.5/src/commands/scenes/get.ts)_
_See code: [src/commands/scenes/get.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.19.0/src/commands/scenes/get.ts)_

## `vertex scenes:list`

Expand All @@ -716,7 +760,7 @@ EXAMPLE
a8070713-e48e-466b-b4bb-b3132895d5ce my-scene-2
```

_See code: [src/commands/scenes/list.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.18.5/src/commands/scenes/list.ts)_
_See code: [src/commands/scenes/list.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.19.0/src/commands/scenes/list.ts)_

## `vertex scenes:render ID`

Expand All @@ -740,7 +784,7 @@ EXAMPLE
54964c61-05d8-4f37-9638-18f7c4960c80.jpg
```

_See code: [src/commands/scenes/render.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.18.5/src/commands/scenes/render.ts)_
_See code: [src/commands/scenes/render.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.19.0/src/commands/scenes/render.ts)_

## `vertex stream-keys:create`

Expand All @@ -762,7 +806,7 @@ EXAMPLE
hBXAoQdnsHVhgDZkxeLEPQVxPJ600QwDMdgq
```

_See code: [src/commands/stream-keys/create.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.18.5/src/commands/stream-keys/create.ts)_
_See code: [src/commands/stream-keys/create.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.19.0/src/commands/stream-keys/create.ts)_

## `vertex webhook-subscriptions:create`

Expand All @@ -784,5 +828,5 @@ EXAMPLE
ta47eOIQtg13pSyf/PgpAB47r4JYJoAZfyzAcB5x8IHo+gQ
```

_See code: [src/commands/webhook-subscriptions/create.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.18.5/src/commands/webhook-subscriptions/create.ts)_
_See code: [src/commands/webhook-subscriptions/create.ts](https://github.com/Vertexvis/vertex-cli/blob/v0.19.0/src/commands/webhook-subscriptions/create.ts)_
<!-- commandsstop -->
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@vertexvis/cli",
"version": "0.18.5",
"version": "0.19.0",
"description": "The Vertex platform command-line interface (CLI).",
"license": "MIT",
"author": "Vertex Developers <support@vertexvis.com> (https://developer.vertexvis.com)",
Expand Down
Loading