c12e/cortex-cli

Cortex CLI

概述

Cortex CLI 是用于 Cortex 平台的命令行工具，提供与平台交互的便捷方式，支持配置账户、管理代理、函数、技能、类型等资源，以及执行查询、过滤结果等操作。

![构建状态]([***]

安装

通过 NPM 安装

bash
npm install -g cortex-cli

通过源码安装

拉取代码后，在 cortex-cli 目录中运行以下命令：

bash
npm install -g .

注意：当该模块发布正式版本后，将通过 npm.org 进行分发。

开发者模式

可将本地 cortex-cli 副本链接到全局安装版本，以便实时应用源码修改：

bash
npm link

此时对源码的修改将立即在本地生效。

使用方法

使用格式

bash
cortex <命令> [子命令] [选项]

通用选项

• -h, --help：显示帮助信息
• -v, --version：显示版本信息

快速开始

bash
cortex configure
Cortex URL [https://api.cortex.insights.ai]:
Account []: <你的租户ID>
Username []: <你的用户名>
Password: **********

登录成功后，配置文件将保存在用户主目录中，包含用于后续使用的认证令牌。（注意：当前，当令牌过期时，您需要重新运行 configure 命令。）

查看代理列表：

bash
cortex agents list
[
  {
    "title": "Movie Recommendation Agent",
    "description": "Makes personalized movie recommendations for users.",
    "createdAt": "2017-12-22T03:07:39.863Z",
    "updatedAt": "2017-12-22T03:12:32.159Z",
    "name": "tutorial/movie_recommendation"
  },
  {
    "title": "Trading Insights Agent",
    "description": "Agent to generate personalized insights for traders.",
    "createdAt": "2017-12-22T03:07:40.109Z",
    "updatedAt": "2017-12-22T03:07:40.201Z",
    "name": "default/trading-insights-agent"
  },
  {
    "title": "Client Complaints Agent",
    "description": "Agent to intercept and classify customer complaints early in the process before it even goes to internal audit.",
    "createdAt": "2017-12-22T03:07:41.287Z",
    "updatedAt": "2017-12-22T03:07:41.360Z",
    "name": "default/client-complaints-agent"
  }
]

使用不同配置文件：

bash
cortex configure --profile myprofile
...
cortex agents list --profile myprofile

使用 --query 选项过滤结果

许多命令支持 --query 选项用于过滤 JSON 响应。查询使用 JMESPath 过滤 JSON 文档。JMESPath 规范可在此处找到：[***] JQ 工具，并被 Amazon AWS 等知名服务支持。

例如，从上述输出中仅选择名称和标题：

bash
cortex agents list --query "[].{name: name, title: title}"
[
  {
    "name": "tutorial/movie_recommendation",
    "title": "Movie Recommendation Agent"
  },
  {
    "name": "default/trading-insights-agent",
    "title": "Trading Insights Agent"
  },
  {
    "name": "default/client-complaints-agent",
    "title": "Client Complaints Agent"
  }
]

命令列表及实现状态

• configure（配置）
  • list（列出配置）
• deploy（部署）
• functions（函数）
  • list（列出函数）
  • describe [functionName]（描述函数）
  • invoke [functionName]（调用函数）
  • deploy [functionName]（部署函数）
  • delete [functionName]（删除函数）
• stacks（堆栈）
  • list（列出堆栈）
  • describe（描述堆栈）
  • deploy（部署堆栈）
  • delete（删除堆栈）
• agents（代理）
  • list（列出代理）
  • save [agentDefinition]（保存代理定义）
  • describe [agentName]（描述代理）
  • delete [agentName]（删除代理）
  • get-snapshots [agentName]（获取代理快照）
  • create-snapshots [snapshotDefinition]（创建快照）
  • invoke [serviceName]（调用服务）
  • get-service-activation [activationId]（获取服务激活信息）
• types（类型）
  • list（列出类型）
  • save [typeDefinition]（保存类型定义）
  • describe [typeName]（描述类型）
  • delete [typeName]（删除类型）
• skills（技能）
  • list（列出技能）
  • save [skillDefinition]（保存技能定义）
  • describe [skillName]（描述技能）
  • delete [skillName]（删除技能）
  • generate（生成技能）
• content（内容）
  • upload（上传内容）
  • download（下载内容）
  • delete（删除内容）
  • list（列出内容）
• jobs（任务）
  • list（列出任务）
  • save（保存任务）
  • describe（描述任务）
  • status（查看任务状态）
  • delete（删除任务）
• tasks（任务）
  • list（列出任务）
  • logs（查看任务日志）
  • cancel（取消任务）
  • describe（描述任务）
• connections（连接）
  • list（列出连接）
  • list-types（列出连接类型）
  • save [connectionDefinition]（保存连接定义）
  • delete [connectionName]（删除连接）
  • describe [connectionName]（描述连接）
  • test [connectionName]（测试连接）
  • generate（生成连接）
• datasets（数据集）
  • list（列出数据集）
  • save [datasetDefinition]（保存数据集定义）
  • delete [datasetName]（删除数据集）
  • describe [datasetName]（描述数据集）
  • get-dataframe [datasetName]（获取数据框）
  • get-stream [datasetName]（获取流）
  • generate（生成数据集）
• snapshots（快照）
• environments（环境）
  • list（列出环境）
  • save [environmentDefinition]（保存环境定义）
  • delete [environmentDefinition]（删除环境定义）
  • describe [environmentName]（描述环境）
• container-registries（容器仓库）
  • list（列出容器仓库）
  • save [registryName]（保存容器仓库）
  • delete [registryName]（删除容器仓库）