# @contrail/cli 中文文档

规范地址：https://npmcn.com/package/%40contrail/cli/

版本：3\.6\.0
npm 元数据更新时间：2026-11-11T16:35:53.508Z
中文译文更新时间：2026-11-11T16:39:36.714Z
软件包许可：未声明

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40contrail/cli
原文对照：https://npmcn.com/package/%40contrail/cli/?lang=original
项目主页：https://www.npmjs.com/package/@contrail/cli

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：48.2 MB，9562 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=18\.0\.0
- 运行依赖：33 个
- 首次发布：2021-12-10T21:05:36.702Z
- 最新版本发布：2026-11-11T16:35:53.251Z
- 近 30 天下载量：7931（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：335（近 12 个月 172 个）

## 中文简介

VibeIQ的反相平台CLI.

## 安装

```sh
npm install @contrail/cli
```

也可以使用：`pnpm add @contrail/cli`、`yarn add @contrail/cli`、`bun add @contrail/cli`

## README

# 反线CLI

Contrail CLI 是通过程序界面管理您实例数据的最佳方式 .

-   [反线CLI](https://npmcn.com/package/%40contrail/cli/#readme-contrail-cli)
-   [使用量](https://npmcn.com/package/%40contrail/cli/#readme-usage)
-   [自动完成](https://npmcn.com/package/%40contrail/cli/#readme-autocomplete)
-   [图标](https://npmcn.com/package/%40contrail/cli/#readme-commands)

# 使用量

```sh-session
$ npm install -g @contrail/cli
$ contrail COMMAND
running command...
$ contrail (--version)
@contrail/cli/3.6.0 linux-x64 node-v24.22.2
$ contrail --help [COMMAND]
USAGE
  $ contrail COMMAND
...
```

# 自动完成

要获得如何为您的外壳设置自动补全的指示, 请运行 `contrail autocomplete`。 。 。 .

# 图标

-   [`contrail app create`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-app-create)
-   [`contrail app delete`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-app-delete)
-   [`contrail app extension deploy`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-app-extension-deploy)
-   [`contrail app extension deployment list`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-app-extension-deployment-list)
-   [`contrail app getApiKey`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-app-getapikey)
-   [`contrail app init`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-app-init)
-   [`contrail app install`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-app-install)
-   [`contrail app publish`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-app-publish)
-   [`contrail app uninstall`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-app-uninstall)
-   [`contrail app upgrade`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-app-upgrade)
-   [`contrail app version major`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-app-version-major)
-   [`contrail app version minor`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-app-version-minor)
-   [`contrail app version patch`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-app-version-patch)
-   [`contrail autocomplete [SHELL]`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-autocomplete-shell)
-   [`contrail config create`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-config-create)
-   [`contrail config describe [NAME]`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-config-describe-name)
-   [`contrail config list`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-config-list)
-   [`contrail config set`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-config-set)
-   [`contrail config use [NAME]`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-config-use-name)
-   [`contrail entities create TYPEPATH`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-entities-create-typepath)
-   [`contrail entities delete ENTITYNAME [IDS]`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-entities-delete-entityname-ids)
-   [`contrail entities get ENTITYNAME [IDS]`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-entities-get-entityname-ids)
-   [`contrail entities update ENTITYNAME [IDS]`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-entities-update-entityname-ids)
-   [`contrail feature-flags export`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-feature-flags-export)
-   [`contrail feature-flags import`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-feature-flags-import)
-   [`contrail file upload FILELOCATION CONTENTTYPE`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-file-upload-filelocation-contenttype)
-   [`contrail groups export`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-groups-export)
-   [`contrail groups import GROUPSFILE`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-groups-import-groupsfile)
-   [`contrail help [COMMANDS]`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-help-commands)
-   [`contrail instance export`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-instance-export)
-   [`contrail instance import`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-instance-import)
-   [`contrail load colors DATAFILE CONFIGFILE`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-load-colors-datafile-configfile)
-   [`contrail load custom-entity DATAFILE CONFIGFILE`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-load-custom-entity-datafile-configfile)
-   [`contrail load line-sheet DATAFILE CONFIGFILE`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-load-line-sheet-datafile-configfile)
-   [`contrail load upload-and-load INCOMINGFILE CONFIGFILENAME`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-load-upload-and-load-incomingfile-configfilename)
-   [`contrail org-config export`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-org-config-export)
-   [`contrail org-config import`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-org-config-import)
-   [`contrail projects export PROJECTNAME`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-projects-export-projectname)
-   [`contrail projects list`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-projects-list)
-   [`contrail projects load TEMPLATEFILELOCATION`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-projects-load-templatefilelocation)
-   [`contrail types exportOptionSetHierarchies`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-types-exportoptionsethierarchies)
-   [`contrail types getAll`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-types-getall)
-   [`contrail types getOptionSets`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-types-getoptionsets)
-   [`contrail types loadAll`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-types-loadall)
-   [`contrail types mergeOptionSets FILE`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-types-mergeoptionsets-file)
-   [`contrail types mergeTypeProperties FILE TYPEPATHS`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-types-mergetypeproperties-file-typepaths)
-   [`contrail types parseOptionSetsHierarchyLocalFile FILE`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-types-parseoptionsetshierarchylocalfile-file)
-   [`contrail types parseOptionSetsHierarchyValuesToKeysLocalFile FILE`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-types-parseoptionsetshierarchyvaluestokeyslocalfile-file)
-   [`contrail types parseOptionSetsLocalFiles FILE`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-types-parseoptionsetslocalfiles-file)
-   [`contrail types parseOptionSetsToFolderStructure FILE`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-types-parseoptionsetstofolderstructure-file)
-   [`contrail types parseTypesFromFiles TYPEPATHS`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-types-parsetypesfromfiles-typepaths)
-   [`contrail types parseTypesFromLocalFiles TYPEPATHS`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-types-parsetypesfromlocalfiles-typepaths)
-   [`contrail types parseTypesFromTemplateAndDataFromLocalFiles TEMPLATEFILE FILEPATHS`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-types-parsetypesfromtemplateanddatafromlocalfiles-templatefile-filepaths)
-   [`contrail types parseTypesFromTemplateFromLocalFiles TEMPLATEFILE FILEPATH`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-types-parsetypesfromtemplatefromlocalfiles-templatefile-filepath)
-   [`contrail types uploadOptionSetHierarchies`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-types-uploadoptionsethierarchies)
-   [`contrail types uploadOptionSets`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-types-uploadoptionsets)
-   [`contrail types uploadOptionSetsHierarchyLocalFile FILE NAME`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-types-uploadoptionsetshierarchylocalfile-file-name)
-   [`contrail types uploadRuleSets`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-types-uploadrulesets)
-   [`contrail types uploadTypeOverrides`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-types-uploadtypeoverrides)
-   [`contrail types uploadTypePolicies`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-types-uploadtypepolicies)
-   [`contrail types uploadTypePropertyPolicies`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-types-uploadtypepropertypolicies)
-   [`contrail types uploadTypes`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-types-uploadtypes)
-   [`contrail users export`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-users-export)
-   [`contrail users import USERSFILE`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-users-import-usersfile)
-   [`contrail webhooks create`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-webhooks-create)
-   [`contrail webhooks delete [WEBHOOKID]`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-webhooks-delete-webhookid)
-   [`contrail webhooks getWebhookTrigger [WEBHOOKID]`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-webhooks-getwebhooktrigger-webhookid)
-   [`contrail webhooks list`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-webhooks-list)
-   [`contrail workflow-template-definitions install`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-workflow-template-definitions-install)
-   [`contrail workflow-template-definitions list`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-workflow-template-definitions-list)
-   [`contrail workflow-templates delete`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-workflow-templates-delete)
-   [`contrail workflow-templates export`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-workflow-templates-export)
-   [`contrail workflow-templates list`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-workflow-templates-list)
-   [`contrail workflow-templates load FILELOCATION`](https://npmcn.com/package/%40contrail/cli/#readme-contrail-workflow-templates-load-filelocation)

## `contrail app create`

创建新应用程序 。 当前组织将被设定为应用程序的拥有者

```
USAGE
  $ contrail app create [-l error|warn|info|debug] [-e true|false]

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Create a new app. The current organization will be set as the owner of the app

EXAMPLES
  $ contrail app create
```

## `contrail app delete`

从应用程序市场中删除该应用程序

```
USAGE
  $ contrail app delete [-l error|warn|info|debug] [-e true|false]

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Delete the app from the app marketplace

EXAMPLES
  $ contrail app delete
```

## `contrail app extension deploy`

从扩展目录向 VibeIQ 管理的 URL 部署扩展 .

```
USAGE
  $ contrail app extension deploy -i <value> [-l error|warn|info|debug] [-e true|false] [-d]

FLAGS
  -d, --debug                      Enable debug mode
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -i, --identifier=<value>         (required) The extension identifier to deploy. The identifier of the extension is the
                                   "identifier" property in the extension defined in the app.yml
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Deploy an extension from the extensions directory to a VibeIQ managed URL.

EXAMPLES
  $ contrail extension deploy --identifier <extensionIdentifier>
```

## `contrail app extension deployment list`

列表扩展部署

```
USAGE
  $ contrail app extension deployment list [-l error|warn|info|debug] [-e true|false] [-a]

FLAGS
  -a, --all                        List all extension deployments. By default, only the latest 20 are shown
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  List extension deployments

EXAMPLES
  $ contrail extension deployment list
```

## `contrail app getApiKey`

为已安装的应用程序获取 api 密钥

```
USAGE
  $ contrail app getApiKey [-l error|warn|info|debug] [-e true|false] [-a <value>]

FLAGS
  -a, --appIdentifier=<value>      The app identifier
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Get an api key for an installed app

EXAMPLES
  $ contrail app getApiKey
```

## `contrail app init`

从模板初始化应用程序目录

```
USAGE
  $ contrail app init [-l error|warn|info|debug] [-e true|false]

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Initialize an app directory from a template

EXAMPLES
  $ contrail app init
```

## `contrail app install`

从市场向特定组织安装应用程序

```
USAGE
  $ contrail app install [-l error|warn|info|debug] [-e true|false] [-i <value>] [-w]

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -i, --appIdentifier=<value>      The identifier of the app to install
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>
  -w, --installWorkflowTemplates   "Install the app's accompanying workflows"

DESCRIPTION
  Install an app from the marketplace to a specific organization

EXAMPLES
  $ contrail app install --appIdentifier @VibeIQ/Flex-PLM-Connector
```

## `contrail app publish`

向市场发布应用程序。 您应用程序的能见度取决于app.yml配置("能见度"属性)

```
USAGE
  $ contrail app publish [-l error|warn|info|debug] [-e true|false] [-u] [-v] [-d]

FLAGS
  -d, --dryRun                     Dry run the upgrade without actually updating the app.
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>
  -u, --upgrade                    In addition to deploying, upgrade the installed version of the app in this org to the
                                   latest one.
  -v, --verbose                    Debug the app deployment step and do not remove the intermediate build artifacts.

DESCRIPTION
  Publish the app to the marketplace. This visibility of your app depends on the app.yml configuration ("visibility"
  property)

EXAMPLES
  $ contrail app publish
```

## `contrail app uninstall`

解开当前安装在特定组织的应用程序

```
USAGE
  $ contrail app uninstall [-l error|warn|info|debug] [-e true|false] [-i <value>]

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -i, --appIdentifier=<value>      "The identifier of the app to uninstall. The identifier can be found on the app's
                                   page in the marketplace."
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Uninstall an app that is currently installed in a specific organization

EXAMPLES
  $ contrail app uninstall --name @vibeiq/flexplm-connector
```

## `contrail app upgrade`

升级特定组织的已安装应用程序

```
USAGE
  $ contrail app upgrade [-l error|warn|info|debug] [-e true|false] [-i <value>] [-l]

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -i, --appIdentifier=<value>      The appIdentifier of the app to install
  -l, --latest                     Upgrade to the latest version of the app
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Upgrade an installed app in a specific organization

EXAMPLES
  $ contrail app upgrade --appIdentifier @VibeIQ/Flex-PLM-Connector --latest
```

## `contrail app version major`

升级主要应用程序版本

```
USAGE
  $ contrail app version major [-l error|warn|info|debug] [-e true|false]

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Upgrade the Major app version

EXAMPLES
  $ contrail app version major
```

## `contrail app version minor`

升级小应用程序版本

```
USAGE
  $ contrail app version minor [-l error|warn|info|debug] [-e true|false]

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Upgrade the Minor app version

EXAMPLES
  $ contrail app version minor
```

## `contrail app version patch`

更新 Patch app 版本

```
USAGE
  $ contrail app version patch [-l error|warn|info|debug] [-e true|false]

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Upgrade the Patch app version

EXAMPLES
  $ contrail app version patch
```

## `contrail autocomplete [SHELL]`

显示自动完成安装指令

```
USAGE
  $ contrail autocomplete [SHELL] [-r]

ARGUMENTS
  SHELL  shell type

FLAGS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)

DESCRIPTION
  display autocomplete installation instructions

EXAMPLES
  $ contrail autocomplete

  $ contrail autocomplete bash

  $ contrail autocomplete zsh

  $ contrail autocomplete --refresh-cache
```

_参见代码 : [@oclif/ plugin- auto 完成](https://github.com/oclif/plugin-autocomplete/blob/v2.1.4/src/commands/autocomplete/index.ts)_

## `contrail config create`

创建新配置文件

```
USAGE
  $ contrail config create --name <value> [-l error|warn|info|debug] [-e true|false]

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>
  --name=<value>                   (required) The config name

DESCRIPTION
  Create a new configuration file

EXAMPLES
  $ contrail config create --name demo-org
```

## `contrail config describe [NAME]`

显示配置文件的内容

```
USAGE
  $ contrail config describe [NAME] [-l error|warn|info|debug] [-e true|false]

ARGUMENTS
  NAME  The config name

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Display the contents of a configuration file

EXAMPLES
  $ contrail config describe demo-org
```

## `contrail config list`

列出配置

```
USAGE
  $ contrail config list [-l error|warn|info|debug] [-e true|false]

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  List the configurations

EXAMPLES
  $ contrail config list
```

## `contrail config set`

在配置中设置变量

```
USAGE
  $ contrail config set [-l error|warn|info|debug] [-e true|false] [--orgSlug <value>] [--environment
    dev|development|prod|production] [--apiUserToken <value>] [--config <value>]

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>
  --apiUserToken=<value>           The API User Token
  --config=<value>                 The config name
  --environment=<option>           The Environment
                                   <options: dev|development|prod|production>
  --orgSlug=<value>                The org slug

DESCRIPTION
  Set a variable in the configuration

EXAMPLES
  $ contrail config set --orgId 1234
```

## `contrail config use [NAME]`

使用特定配置

```
USAGE
  $ contrail config use [NAME] [-l error|warn|info|debug] [-e true|false]

ARGUMENTS
  NAME  The config name

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Use a specific configuration

EXAMPLES
  $ contrail config use demo-org
```

## `contrail entities create TYPEPATH`

创建实体

```
USAGE
  $ contrail entities create TYPEPATH [-l error|warn|info|debug] [-e true|false] [-n <value>] [-d] [-i <value>] [-o
    <value>] [-g] [-r] [-S] [--suffix <value>] [--apiVersion 1|2]

ARGUMENTS
  TYPEPATH  The type path of the entity to create (e.g. color, custom-entity:franchise)

FLAGS
  -S, --skipHydrateRelationships   If true, does not hydrate relationships for the created entities
  -d, --dryRun                     If true, does not create the entity but simulates the creation
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -g, --generateValues             If true, generates random values for properties that are not specified. By default,
                                   only specified properties are used.
  -i, --inputFile=<value>          A file with a JSON array of objects where each object is one entity to create. Cannot
                                   be used with --count. Unless --generateValues is specified, only the properties in
                                   the file will be used.
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>
  -n, --count=<value>              Number of random entities to create
  -o, --outputFile=<value>         File to save the output (optional)
  -r, --readableIds                If true, uses readable IDs for the created entities
  --apiVersion=<option>            Api-Version header to send; selects the V1 or V2 variant of the endpoint
                                   <options: 1|2>
  --suffix=<value>                 Append a sub-route to the entity endpoint (e.g. --suffix=synchronous targets
                                   /<entities>/synchronous)

DESCRIPTION
  Create entities

EXAMPLES
  $ contrail entities create color -g -n=10 # creates 10 random colors

  $ contrail entities create color -- name="Electric Blue" green=1 red=2 blue=3 # creates one color with specified properties only

  $ contrail entities create custom-entity:franchise

  $ contrail entities create project-item -n=10 -- projectId=abc # creates 10 project items within project ABC

  $ contrail entities create color -g -r # creates a random color with a human readable ID

  $ contrail entities create color -d -- name=test # simulates the creation of a color without actually creating it

  $ contrail entities create custom-entity:franchise -S # creates an entity and the response does not contain hydrated relationships

  $ contrail entities create color -g -- name="Electric Blue" # creates a color with the name specified and other properties auto-generated

  $ contrail entities create color -o /tmp/colors.json -- name=Blue green=1 red=2 blue=3 # creates a color and saves the output to /tmp/colors.json
```

## `contrail entities delete ENTITYNAME [IDS]`

以 id 删除实体

```
USAGE
  $ contrail entities delete ENTITYNAME [IDS] [-l error|warn|info|debug] [-e true|false] [-d] [-i <value>] [--suffix
    <value>] [--apiVersion 1|2]

ARGUMENTS
  ENTITYNAME  The name of the entity type to delete (type paths are not supported)
  IDS         One or more entity ids to delete

FLAGS
  -d, --dryRun                     If true, does not delete the entities but simulates the deletion
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -i, --inputFile=<value>          A file with a JSON array of objects; only each object's id is used. Deletes every
                                   entity in the file.
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>
  --apiVersion=<option>            Api-Version header to send; selects the V1 or V2 variant of the endpoint
                                   <options: 1|2>
  --suffix=<value>                 Append a sub-route to the entity endpoint (e.g. --suffix=synchronous targets
                                   /<entities>/synchronous)

DESCRIPTION
  Delete entities by id

EXAMPLES
  $ contrail entities delete color 123

  $ contrail entities delete color id1 id2 id3

  $ contrail entities delete item -i ids.json
```

## `contrail entities get ENTITYNAME [IDS]`

获取实体

```
USAGE
  $ contrail entities get ENTITYNAME [IDS] [-l error|warn|info|debug] [-e true|false] [-o <value>] [-p <value>]
    [-P] [-s <value>] [-S] [-t <value>] [-r <value>] [--suffix <value>] [--apiVersion 1|2]

ARGUMENTS
  ENTITYNAME  The name of the entity type to fetch (type paths are not supported)
  IDS         One or more entity ids; shorthand for the id/ids criteria

FLAGS
  -P, --paginated                  If true, fetches all entities in a paginated manner
  -S, --skipHydrateRelationships   Skip hydrating relationships when fetching the entity
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>
  -o, --outputFile=<value>         File to save the output (optional)
  -p, --propertySlugs=<value>      Comma-separated list of property slugs to include in the output. Only some entity
                                   types support this; the rest return full records.
  -r, --relations=<value>          Comma-separated list of relations to include in the output
  -s, --skip=<value>               Number of entities to skip
  -t, --take=<value>               Number of entities to fetch in a single request (default is 100)
  --apiVersion=<option>            Api-Version header to send; selects the V1 or V2 variant of the endpoint
                                   <options: 1|2>
  --suffix=<value>                 Append a sub-route to the entity endpoint (e.g. --suffix=synchronous targets
                                   /<entities>/synchronous)

DESCRIPTION
  Get an entity

EXAMPLES
  $ contrail entities get color 123

  $ contrail entities get color id1 id2 id3

  $ contrail entities get color -- id=123

  $ contrail entities get loader-process -- createdOn=2026-09-01..2026-09-11

  $ contrail entities get loader-process -- createdOn=2026-09-05..

  $ contrail entities get loader-process -- createdOn=..2026-09-05
```

## `contrail entities update ENTITYNAME [IDS]`

更新一个实体

```
USAGE
  $ contrail entities update ENTITYNAME [IDS] [-l error|warn|info|debug] [-e true|false] [-S] [-d] [-i <value>]
    [--suffix <value>] [--apiVersion 1|2]

ARGUMENTS
  ENTITYNAME  The name of the entity type to update (type paths are not supported)
  IDS         One or more entity ids to update

FLAGS
  -S, --skipHydrateRelationships   Skip hydrating relationships when updating the entity
  -d, --dryRun                     If true, does not update the entities but simulates the update
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -i, --inputFile=<value>          A file with a JSON array of {id, ...} objects; each object is one entity to update.
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>
  --apiVersion=<option>            Api-Version header to send; selects the V1 or V2 variant of the endpoint
                                   <options: 1|2>
  --suffix=<value>                 Append a sub-route to the entity endpoint (e.g. --suffix=synchronous targets
                                   /<entities>/synchronous)

DESCRIPTION
  Update an entity

EXAMPLES
  $ contrail entities update color 123 -- name=obsidian hex=000000

  $ contrail entities update item id1 id2 id3 -- colorName=obsidian # apply the same change to several entities

  $ contrail entities update color 123 -- federatedId= name='""' # Unset federatedId, set name to empty string
```

## `contrail feature-flags export`

导出您 Org 的已启用特性旗

```
USAGE
  $ contrail feature-flags export [-l error|warn|info|debug] [-e true|false] [-d <value>] [-f]

FLAGS
  -d, --outDir=<value>             [default: .] The directory to which to export the feature flags. Defaults to the
                                   current directory
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -f, --overwrite                  Replaces any existing export files in outDir
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Export the enabled feature flags for your Org

EXAMPLES
  $ contrail feature-flags export
```

## `contrail feature-flags import`

上传已提取的特性旗

```
USAGE
  $ contrail feature-flags import [-l error|warn|info|debug] [-e true|false] [-d <value>]

FLAGS
  -d, --dir=<value>                [default: .] The directory from which to import the feature flags. Defaults to the
                                   current directory. The feature flags will be loaded from $dir/feature-flags.yml
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Upload an extracted set of feature flags

EXAMPLES
  $ contrail feature-flags import
```

## `contrail file upload FILELOCATION CONTENTTYPE`

上传一个文件到 VibeIQ 平台

```
USAGE
  $ contrail file upload FILELOCATION CONTENTTYPE [-l error|warn|info|debug] [-e true|false]

ARGUMENTS
  FILELOCATION  The location of the file on upload
  CONTENTTYPE   [default: application/text] The Content Type of the file being uploaded. Defaults to application/text

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Uploads a file to the VibeIQ platform

EXAMPLES
  $ contrail file upload <FILE_LOCATION>
```

## `contrail groups export`

导出 org 中的所有组 .

```
USAGE
  $ contrail groups export [-l error|warn|info|debug] [-e true|false] [-f <value>] [--overwrite]

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -f, --outFile=<value>            [default: groups.yml] The location for the file to be saved
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>
  --overwrite                      Replaces existing files if they exist

DESCRIPTION
  Export all groups in the org.

EXAMPLES
  $ contrail groups export
```

## `contrail groups import GROUPSFILE`

从 yml 导入所有组 。 在当前目录中使用 group.yml 文件 .

```
USAGE
  $ contrail groups import GROUPSFILE [-l error|warn|info|debug] [-e true|false]

ARGUMENTS
  GROUPSFILE  The .yml file containing the groups

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Import all groups from a yml. Uses the groups.yml file in the current directory.

EXAMPLES
  $ contrail groups import <GROUPS_FILE>

  $ contrail groups import --groupsFile <GROUPS_FILE>
```

## `contrail help [COMMANDS]`

显示反向帮助 .

```
USAGE
  $ contrail help [COMMANDS] [-n]

ARGUMENTS
  COMMANDS  Command to show help for.

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

DESCRIPTION
  Display help for contrail.
```

_参见代码 : [@oclif/plugin-帮助](https://github.com/oclif/plugin-help/blob/v5.2.20/src/commands/help.ts)_

## `contrail instance export`

输出一个实例的数据,包括类型和用户

```
USAGE
  $ contrail instance export [-l error|warn|info|debug] [-e true|false] [-d <value>] [-f]

FLAGS
  -d, --outDir=<value>             [default: .] The directory to which to export the instance data. Defaults to the
                                   current directory
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -f, --overwrite                  Replaces any existing export files in outDir
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Exports an data of an instance including types and users

EXAMPLES
  $ contrail instance export
```

## `contrail instance import`

将数据导入实例, 包括类型和用户

```
USAGE
  $ contrail instance import [-l error|warn|info|debug] [-e true|false] [-d <value>]

FLAGS
  -d, --dir=<value>                [default: .] The directory from which to export the instance data. Defaults to the
                                   current directory
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Import the data to an instance, including types and users

EXAMPLES
  $ contrail instance import
```

## `contrail load colors DATAFILE CONFIGFILE`

从 CSV 文件装入颜色对象并配置 YAML

```
USAGE
  $ contrail load colors DATAFILE CONFIGFILE [-l error|warn|info|debug] [-e true|false]

ARGUMENTS
  DATAFILE    The CSV data file
  CONFIGFILE  The YAML configuration file

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Loads colors object from a CSV file and config YAML

EXAMPLES
  $ contrail load colors <CSV file> <config yaml>
```

## `contrail load custom-entity DATAFILE CONFIGFILE`

从 CSV 文件装入自定义实体对象并配置 YAML

```
USAGE
  $ contrail load custom-entity DATAFILE CONFIGFILE [-l error|warn|info|debug] [-e true|false]

ARGUMENTS
  DATAFILE    The CSV data file
  CONFIGFILE  The YAML configuration file

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Loads custom-entity object from a CSV file and config YAML

EXAMPLES
  $ contrail load custom-entity <CSV file> <config yaml>
```

## `contrail load line-sheet DATAFILE CONFIGFILE`

从 CSV 文件装入行表数据并配置 YAML

```
USAGE
  $ contrail load line-sheet DATAFILE CONFIGFILE [-l error|warn|info|debug] [-e true|false]

ARGUMENTS
  DATAFILE    The CSV data file
  CONFIGFILE  The YAML configuration file

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Loads line sheet data from a CSV file and config YAML

EXAMPLES
  $ contrail load line-sheet <CSV file> <config yaml>
```

## `contrail load upload-and-load INCOMINGFILE CONFIGFILENAME`

上传 csv 文件并踢出上传文件的负载任务 。 文件路径必须是引用.csv文件,而配置路径必须是引用.json或.yml文件

```
USAGE
  $ contrail load upload-and-load INCOMINGFILE CONFIGFILENAME [-l error|warn|info|debug] [-e true|false]

ARGUMENTS
  INCOMINGFILE    The incoming file location
  CONFIGFILENAME  The configuration file location

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Upload a csv file and kick off a load job for the uploaded file. The file path must be a reference to a .csv file and
  the config path must be a reference to a .json or a .yml file

EXAMPLES
  $ contrail load-processor upload-and-load  <File Path> <Config Path>
```

## `contrail org-config export`

导出您的 Org 配置

```
USAGE
  $ contrail org-config export [-l error|warn|info|debug] [-e true|false] [-d <value>] [-f]

FLAGS
  -d, --outDir=<value>             [default: .] The directory to which to export the org config data. Defaults to the
                                   current directory
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -f, --overwrite                  Replaces any existing export files in outDir
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Export the org config for your Org

EXAMPLES
  $ contrail org-config export
```

## `contrail org-config import`

上传已提取的 org 配置

```
USAGE
  $ contrail org-config import [-l error|warn|info|debug] [-e true|false] [-d <value>]

FLAGS
  -d, --dir=<value>                [default: .] The directory from which to import the org config data. Defaults to the
                                   current directory. The org config data will be loaded from $dir/org-config.yml
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Upload an extracted org config

EXAMPLES
  $ contrail org-config import
```

## `contrail projects export PROJECTNAME`

导出一个项目 .

```
USAGE
  $ contrail projects export PROJECTNAME [-l error|warn|info|debug] [-e true|false]

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Export a project.

EXAMPLES
  $ contrail project export <PROJECT_NAME>
```

## `contrail projects list`

获取所有项目的列表 .

```
USAGE
  $ contrail projects list [-l error|warn|info|debug] [-e true|false]

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Get a list of all projects.

EXAMPLES
  $ contrail project list
```

## `contrail projects load TEMPLATEFILELOCATION`

从 yml 文件配置一个工程 .

```
USAGE
  $ contrail projects load TEMPLATEFILELOCATION [-l error|warn|info|debug] [-e true|false]

ARGUMENTS
  TEMPLATEFILELOCATION  The location to the template file

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Configure a project from a yml file.

EXAMPLES
  $ contrail project load <TEMPLATE_FILE_LOCATION>
```

## `contrail types exportOptionSetHierarchies`

导出 OptionSetHierarchies 到 CSV .

```
USAGE
  $ contrail types exportOptionSetHierarchies [-l error|warn|info|debug] [-e true|false]

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  export OptionSetHierarchies into CSVs.

EXAMPLES
  $ contrail types exportOptionSetsHierarchies
```

## `contrail types getAll`

为您的 Org 获取所有类型和相关数据

```
USAGE
  $ contrail types getAll [-l error|warn|info|debug] [-e true|false] [-d <value>] [-f]

FLAGS
  -d, --outDir=<value>             [default: .] The directory to which to export the type data. Defaults to the current
                                   directory
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -f, --overwrite                  Replaces any existing export files in outDir
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Get all Types and associated data for your Org

EXAMPLES
  $ contrail types getAll
```

## `contrail types getOptionSets`

为您的 Org 获取所有选项集和相关数据

```
USAGE
  $ contrail types getOptionSets [-l error|warn|info|debug] [-e true|false] [--format YAML|CSV] [-d <value>] [-f]

FLAGS
  -d, --outDir=<value>             [default: .] The directory to which to export the option sets data. Defaults to the
                                   current directory
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -f, --overwrite                  Replaces any existing export files in outDir
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>
  --format=<option>                <options: YAML|CSV>

DESCRIPTION
  Get all option sets and associated data for your Org

EXAMPLES
  $ contrail types getOptionSets --format <YAML or CSV>
```

## `contrail types loadAll`

装入所有通过 getAll导出的类型数据

```
USAGE
  $ contrail types loadAll [-l error|warn|info|debug] [-e true|false] [-d <value>] [--orgConfig]

FLAGS
  -d, --dir=<value>                [default: .] The directory from which to load the types data. Defaults to the current
                                   directory.
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>
  --[no-]orgConfig                 Also load org config data from this directory. If not specified, you will be
                                   prompted.

DESCRIPTION
  loads all the type data that has been exported by getAll

EXAMPLES
  $ contrail types loadAll
```

## `contrail types mergeOptionSets FILE`

将 OptionSets 与 已存在的 Org 合并,并将 OptionSets 合并。 OptionSets 文件必须是.yml或带有yml文件的目录. 文件可以包含单个选项集或一系列选项集.

```
USAGE
  $ contrail types mergeOptionSets FILE [-l error|warn|info|debug] [-e true|false]

ARGUMENTS
  FILE  File (or directory) to merge with the cloud option sets

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Merge the OptionSets from an existing org and the OptionSets passed in. OptionSets File must be .yml or a directory
  with yml files.  The files can contain a single option set or an array of option sets.

EXAMPLES
  $ contrail types mergeOptionSets <File Path>
```

## `contrail types mergeTypeProperties FILE TYPEPATHS`

将类型Properties与已存在的 Org 合并,并将类型Properties 合并。 通过 TypePath 文件添加到类型必须是.yml

```
USAGE
  $ contrail types mergeTypeProperties FILE TYPEPATHS [-l error|warn|info|debug] [-e true|false]

ARGUMENTS
  FILE       File to parse
  TYPEPATHS  A list of the type paths to merge

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Merge the TypeProperties from an existing org and the TypeProperties passed in. Add to Types via TypePath File must be
  .yml

EXAMPLES
  $ contrail types mergeTypeProperties <File Path> <TypePaths>
```

## `contrail types parseOptionSetsHierarchyLocalFile FILE`

将 CSV 文件分析为 OptionSetHierarchy

```
USAGE
  $ contrail types parseOptionSetsHierarchyLocalFile FILE [-l error|warn|info|debug] [-e true|false]

ARGUMENTS
  FILE  File to parse

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Parse CSV file into OptionSetHierarchy

EXAMPLES
  $ contrail types parseOptionSetsHierarchyLocalFile <File Paths>
```

## `contrail types parseOptionSetsHierarchyValuesToKeysLocalFile FILE`

将 CSV 文件分析为 OptionSetHierarchy

```
USAGE
  $ contrail types parseOptionSetsHierarchyValuesToKeysLocalFile FILE [-l error|warn|info|debug] [-e true|false]

ARGUMENTS
  FILE  File to parse

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Parse CSV file into OptionSetHierarchy

EXAMPLES
  $ contrail types parseOptionSetsHierarchyValuesToKeysLocalFile <File Paths>
```

## `contrail types parseOptionSetsLocalFiles FILE`

将 CSV 文件分析为 OptionSets 。 样式表示 csv 的格式 。 如果 csv 文件有选项设置名、 选项密钥和选项标签的列, 请使用“ Name AndLabelAndKey ” 。 如果文件为每套选项设置了一列并列为标签值,则使用"LabelsInColumn". 在"LabelsInColumn"中,密钥是自动生成的.

```
USAGE
  $ contrail types parseOptionSetsLocalFiles FILE --csvStyle NameAndLabelAndKey|LabelsInColumn [-l error|warn|info|debug] [-e
    true|false]

ARGUMENTS
  FILE  File to parse

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>
  --csvStyle=<option>              (required)
                                   <options: NameAndLabelAndKey|LabelsInColumn>

DESCRIPTION
  Parse CSV files into OptionSets. Style denotes the format the csv is in. If the csv file has a column for option
  setname, option key, and option label, use "NameAndLabelAndKey". If the file has one column for each option set with
  the rows being the label value use "LabelsInColumn". In the case of LabelsInColumn, the keys are autogenerated.

  Example file for LabelsInColumn would be

  Gender, Countries, Brands
  men, spain, prada
  women, france, converse
  unisex, australia
  , usa
  , egypt

  Example file for NameAndLabelAndKey would be

  Gender, g_men, Men
  Bender, g_women, Women
  Gender g_uni, Unisex
  Countries, co_spain, Spain
  Countries, co_france, France
  Countries, co_aus, Australia
  Countries, co_usa, United States of America,
  Countries, co_egypt, Egypt


EXAMPLES
  $ contrail types parseOptionSetsLocalFiles <File Paths> <style>
```

## `contrail types parseOptionSetsToFolderStructure FILE`

解析包含多个选项集的 YAML 文件( 如输出 `parseOptionSetLocalFiles`),并在目录中将它们分割成多个文件. 生成的文件可以使用 `uploadOptionSets`

```
USAGE
  $ contrail types parseOptionSetsToFolderStructure FILE [-l error|warn|info|debug] [-e true|false]

ARGUMENTS
  FILE  File to parse

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Parses a YAML file containing multiple option sets (like the output of `parseOptionSetLocalFiles`) and separates them
  into multiple files in a directory. The resulting files can be uploaded using `uploadOptionSets`

EXAMPLES
  $ contrail types parseOptionSetsLocalFiles <File Paths>
```

## `contrail types parseTypesFromFiles TYPEPATHS`

从 VibeIQ 文件将 CSV 文件分析为类型和选项Sets .

```
USAGE
  $ contrail types parseTypesFromFiles TYPEPATHS [-l error|warn|info|debug] [-e true|false]

ARGUMENTS
  TYPEPATHS  A list of the VibeIQ file IDs to parse

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Parse CSV files into Types and OptionSets from VibeIQ Files.
  File must be .yml.

EXAMPLES
  $ contrail types parseTypesFromFiles <fileIds>
```

## `contrail types parseTypesFromLocalFiles TYPEPATHS`

从本地文件将 CSV 文件分析为类型和选项Sets .

```
USAGE
  $ contrail types parseTypesFromLocalFiles TYPEPATHS [-l error|warn|info|debug] [-e true|false]

ARGUMENTS
  TYPEPATHS  A list of the files to parse

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Parse CSV files into Types and OptionSets from local files.

EXAMPLES
  $ contrail types parseTypesFromLocalFiles <File Paths>
```

## `contrail types parseTypesFromTemplateAndDataFromLocalFiles TEMPLATEFILE FILEPATHS`

从本地类型模板文件将 CSV 文件分析为类型和选项Sets .

```
USAGE
  $ contrail types parseTypesFromTemplateAndDataFromLocalFiles TEMPLATEFILE FILEPATHS [-l error|warn|info|debug] [-e
  true|false]

ARGUMENTS
  TEMPLATEFILE  The template file to use
  FILEPATHS     A list of data file to use

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Parse CSV files into Types and OptionSets from local type template files.

EXAMPLES
  $ contrail types parseTypesFromTemplateAndDataFromLocalFiles <Template Path> <File Paths>
```

## `contrail types parseTypesFromTemplateFromLocalFiles TEMPLATEFILE FILEPATH`

从本地类型模板文件将 CSV 文件分析为类型和选项Sets .

```
USAGE
  $ contrail types parseTypesFromTemplateFromLocalFiles TEMPLATEFILE FILEPATH [-l error|warn|info|debug] [-e true|false]

ARGUMENTS
  TEMPLATEFILE  The template file to use
  FILEPATH      The data file to use

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Parse CSV files into Types and OptionSets from local type template files.

EXAMPLES
  $ contrail types parseTypesFromTemplateFromLocalFiles <Template File> <Data File>
```

## `contrail types uploadOptionSetHierarchies`

上传您的 Org 的选项集等级。 选项集的等级从 .yml 文件中加载到选项集- 等级目录 .

```
USAGE
  $ contrail types uploadOptionSetHierarchies [-l error|warn|info|debug] [-e true|false] [-d <value>]

FLAGS
  -d, --dir=<value>                [default: .] The directory from which to export the option set hierarchies data.
                                   Defaults to the current directory. The option set data will be loaded from
                                   $dir/option-set-hierarchies
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Upload Option Set Hierarchies for your Org. Option set hierarchies are loaded from .yml files in the
  option-set-hierarchies directory.

EXAMPLES
  $ contrail types uploadOptionSetHierarchies
```

## `contrail types uploadOptionSets`

上传 OptionSets for your Org。 OptionSets 是从选项集目录中的.yml 文件装入的.

```
USAGE
  $ contrail types uploadOptionSets [-l error|warn|info|debug] [-e true|false] [-d <value>]

FLAGS
  -d, --dir=<value>                [default: .] The directory from which to export the option set data. Defaults to the
                                   current directory. The option set data will be loaded from $dir/option-sets
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Upload OptionSets for your Org. OptionSets are loaded from .yml files in the option-sets directory.

EXAMPLES
  $ contrail types uploadOptionSets
```

## `contrail types uploadOptionSetsHierarchyLocalFile FILE NAME`

上传 CSV 文件到 optionSetHierarchy

```
USAGE
  $ contrail types uploadOptionSetsHierarchyLocalFile FILE NAME [-l error|warn|info|debug] [-e true|false]

ARGUMENTS
  FILE  File to parse
  NAME  The name to be give to the option set hierarchy

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  upload CSV file into OptionSetHierarchy

EXAMPLES
  $ contrail types uploadOptionSetsHierarchyLocalFile <File Path> <name>
```

## `contrail types uploadRuleSets`

上传已提取的规则集

```
USAGE
  $ contrail types uploadRuleSets [-l error|warn|info|debug] [-e true|false] [-d <value>]

FLAGS
  -d, --dir=<value>                [default: .] The directory from which to export the rule set data. Defaults to the
                                   current directory. The rule set data will be loaded from $dir/rule-sets/*.yml
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Upload an extracted rule set

EXAMPLES
  $ contrail types uploadRuleSets
```

## `contrail types uploadTypeOverrides`

上传类型覆盖

```
USAGE
  $ contrail types uploadTypeOverrides [-l error|warn|info|debug] [-e true|false] [-d <value>]

FLAGS
  -d, --dir=<value>                [default: .] The directory from which to export the type override data. Defaults to
                                   the current directory. The type override data will be loaded from
                                   $dir/type-overrides.yml
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Upload type overrides

EXAMPLES
  $ contrail types uploadTypeOverrides
```

## `contrail types uploadTypePolicies`

上传类型策略

```
USAGE
  $ contrail types uploadTypePolicies [-l error|warn|info|debug] [-e true|false] [-d <value>]

FLAGS
  -d, --dir=<value>                [default: .] The directory from which to export the type policy data. Defaults to the
                                   current directory. The type policy data will be loaded from $dir/type-policies/*.yml
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Upload type policies

EXAMPLES
  $ contrail types UploadTypePolicies
```

## `contrail types uploadTypePropertyPolicies`

上传属性政策

```
USAGE
  $ contrail types uploadTypePropertyPolicies [-l error|warn|info|debug] [-e true|false] [-d <value>]

FLAGS
  -d, --dir=<value>                [default: .] The directory from which to export the type property policy data.
                                   Defaults to the current directory. The type property policy data will be loaded from
                                   $dir/type-property-policies/*.yml
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Upload type property policies

EXAMPLES
  $ contrail types uploadTypePropertyPolicies
```

## `contrail types uploadTypes`

上传类型 Org. optionSets是从类型目录中的.yml文件中加载的.

```
USAGE
  $ contrail types uploadTypes [-l error|warn|info|debug] [-e true|false] [-d <value>] [-m]

FLAGS
  -d, --dir=<value>                [default: .] The directory from which to export the option set data. Defaults to the
                                   current directory. The option set data will be loaded from $dir/types
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>
  -m, --merge                      Merge types and type properties without deleting missing ones. Only adds/updates
                                   those present in the source files.

DESCRIPTION
  Upload Types Org. OptionSets are loaded from .yml files in the types directory.

EXAMPLES
  $ contrail types uploadTypes
```

## `contrail users export`

导出 org 中的所有用户 .

```
USAGE
  $ contrail users export [-l error|warn|info|debug] [-e true|false] [-f <value>] [--overwrite]

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -f, --outFile=<value>            [default: users.yml] The location for the file to be saved
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>
  --overwrite                      Replaces existing files if they exist

DESCRIPTION
  Export all users in the org.

EXAMPLES
  $ contrail users export
```

## `contrail users import USERSFILE`

导入用户. yml 文件内的所有用户

```
USAGE
  $ contrail users import USERSFILE [-l error|warn|info|debug] [-e true|false]

ARGUMENTS
  USERSFILE  The .yml file containing the users

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Import all users in the users.yml file

EXAMPLES
  $ contrail users import <USERS_FILE>
```

## `contrail webhooks create`

创建新 Webhook

```
USAGE
  $ contrail webhooks create [-l error|warn|info|debug] [-e true|false] [-j]

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -j, --json                       output in json format
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Create a new webhook

EXAMPLES
  $ contrail webhooks create
```

## `contrail webhooks delete [WEBHOOKID]`

删除已存在的 Webhook 。 要删除一个网名,请通过它的ID。 要删除多个webhooks, 请不要传递ID的值, 并使用交互选择器选择多个

```
USAGE
  $ contrail webhooks delete [WEBHOOKID] [-l error|warn|info|debug] [-e true|false] [-j]

ARGUMENTS
  WEBHOOKID  The id of the webhook to delete

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -j, --json                       output in json format
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Delete an existing webhook. To delete a single webhook, pass its ID. To delete multiple webhooks, do not pass a value
  for the ID, and select multiple using the interactive selector

EXAMPLES
  $ contrail webhooks delete

  $ contrail webhooks delete 12345abcd-1234-abcd-1234-12345abcde
```

## `contrail webhooks getWebhookTrigger [WEBHOOKID]`

手动一个可用于事件工作流程的webhook触发器. 此命令不会改变任何 Webhook 或事件工作流程的状态 。 它只是用于生成网钩触发器的一种工具.

```
USAGE
  $ contrail webhooks getWebhookTrigger [WEBHOOKID] [-l error|warn|info|debug] [-e true|false]

ARGUMENTS
  WEBHOOKID  The id of the webhook to delete

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Crafts a webhook trigger that can be used for event workflows. This command does not alter the state of any webhook or
  event workflow. It is only a utility for generating a webhook trigger.

EXAMPLES
  $ contrail webhooks getWebhookTrigger 1234-abcd-1234-abcd-1234abcd
```

## `contrail webhooks list`

列出当前网点

```
USAGE
  $ contrail webhooks list [-l error|warn|info|debug] [-e true|false] [-j]

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -j, --json                       output in json format
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  List current webhooks

EXAMPLES
  $ contrail webhooks list
```

## `contrail workflow-template-definitions install`

安装应用程序的模板定义到您的 Org

```
USAGE
  $ contrail workflow-template-definitions install [-l error|warn|info|debug] [-e true|false]

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Install the template definitions of an app to your org

EXAMPLES
  $ contrail workflow-template-definitions install
```

## `contrail workflow-template-definitions list`

在 Org 中列出工作流程模板

```
USAGE
  $ contrail workflow-template-definitions list [-l error|warn|info|debug] [-e true|false]

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Lists the workflow templates in the org

EXAMPLES
  $ contrail workflow-template-definitions list
```

## `contrail workflow-templates delete`

从您的 Org 删除工作流程模板

```
USAGE
  $ contrail workflow-templates delete [-l error|warn|info|debug] [-e true|false]

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Delete workflow templates from your org

EXAMPLES
  $ contrail workflow-templates delete
```

## `contrail workflow-templates export`

导出 org 中的所有工作流程 .

```
USAGE
  $ contrail workflow-templates export [-l error|warn|info|debug] [-e true|false] [-f <value>] [--overwrite]

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -f, --outFile=<value>            [default: workflows.yml] The location for the file to be saved
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>
  --overwrite                      Replaces existing files if they exist

DESCRIPTION
  Export all workflows in the org.

EXAMPLES
  $ contrail workflow-templates export
```

## `contrail workflow-templates list`

在 Org 中列出工作流程模板

```
USAGE
  $ contrail workflow-templates list [-l error|warn|info|debug] [-e true|false]

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Lists the workflow templates in the org

EXAMPLES
  $ contrail workflow-templates list
```

## `contrail workflow-templates load FILELOCATION`

从本地文件装入工作流程

```
USAGE
  $ contrail workflow-templates load FILELOCATION [-l error|warn|info|debug] [-e true|false]

ARGUMENTS
  FILELOCATION  The workflow template file to load

FLAGS
  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                   <options: true|false>
  -l, --logLevel=<option>          The Log Level
                                   <options: error|warn|info|debug>

DESCRIPTION
  Loads your workflow from a local file

EXAMPLES
  $ contrail workflow-templates load <FILE_LOCATION>
```

## 常见问题

### @contrail/cli 是什么？

VibeIQ的反相平台CLI\.

### 如何安装 @contrail/cli？

在项目目录运行 npm install @contrail/cli，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 contrail、contrail-cli，可以用 npx contrail 直接运行。

### @contrail/cli 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @contrail/cli 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @contrail/cli 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=18\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @contrail/cli 可以商用吗？

@contrail/cli 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @contrail/cli 的下载量有多少？

根据 npm 官方下载统计，@contrail/cli 在 2026/10/11 – 2026/11/09 这 30 天内被下载 7,931 次，日均约 264 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @contrail/cli 还在维护吗？

最新版本 3\.6\.0 发布于 2026/11/12（今天）；至今共发布 335 个版本，其中过去 12 个月发布了 172 个；首次发布于 2021/12/11。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。