功能介绍 | 大装置帮助中心
跳到主要内容

功能介绍

什么是 SCO CLI？​

CLI，全称 Command Line Interface，中文名为命令行界面。它是一种与计算机交互的方式，通过输入命令和参数来执行各种操作。 商汤大装置命令行工具服务（SenseCore Command Line Interface，SCO CLI）是为大装置发布的OPEN API提供的命令行管理工具。

SCO CLI 优点​

  • 灵活性：

SCO CLI允许用户进行高度定制化的操作，而不受图形用户界面（GUI）的限制。您可以根据自己的需求自由组合命令，实现各种各样的功能。

  • 效率：

不需要处理复杂的图形界面，CLI比GUI更快。无论是文件操作、网络连接还是程序启动，SCO CLI都能快速响应。

  • 跨平台性：

SCO CLI支持多操作系统，因此更容易跨平台使用。无论在Windows、Linux还是macOS上工作，都可以使用类似的命令。

  • 强大的脚本功能：

SCO CLI支持脚本编程，这意味着您可以将多个命令组合在一起，形成一个可执行的脚本。这样，您就可以自动化许多重复的任务，提高效率。

  • 易于自定义：

SCO CLI的另一个优点是它非常容易自定义。您可以修改默认设置，创建自己的别名，甚至可以编写自己的命令。

  • 丰富的工具库：

SCO CLI有许多内置的工具和命令，可以帮助您完成各种任务，如文件操作、网络管理、进程控制等。而且，由于开源社区的贡献，还有许多第三方工具可供使用。

  • 安全性：

SCO CLI的操作记录可以被保存，这使得审计和追踪变得容易。另外，CLI的权限管理也非常严格，可以帮助防止未经授权的访问。

如何使用 SCO CLI​

安装​

sco 支持以下系统：linux/amd64、linux/arm64、darwin/amd64、darwin/arm64、windows/amd64。

Linux/macOS 安装​

执行以下命令安装 sco：

curl -sSfL https://sco.sensecore.cn/registry/sco/install.sh  | sh && export PATH=~/.sco/bin:$PATH

安装成功之后，会有如下类似的提示信息：

SenseCore Command Line Interface: 
Version:          v1.0.1-dev.34.gf8dc37c
Go Version:       go version go1.21.1 linux/amd64
Git Commit:       f8dc37cef6005a3a7adcc03c94cd149bd63ec822
Build Time (UTC): 2023-12-18 01:08:04

注意：如果你的默认shell是bash，需要安装自动补全工具 bash-completion。你可以使用命令 type _init_completion 检查 bash-completion 是否已安装。如果未安装，可以通过以下命令来安装它。依据包管理工具的实际情况，你需要在 bash 配置文件中导入（source） bash_completion 文件。

  • 基于 Debian 的发行版：apt-get install bash_completion
  • 基于 Red Hat 的发行版：yum install bash-completion
  • maxOS 系统：brew install bash-completion@2

bash-completion 有两个版本：v1 和 v2。v1 对应 Bash 3.2（也是 macOS 的默认安装版本）， v2 对应 Bash 4.1+。为了在 macOS 上使用 sco 补全功能，你必须要安装和使用 Bash 4.1+（也就是 Bash 4.1 或更新的版本）和 bash-completion v2。

Windows 安装​

打开 PowerShell，执行以下命令安装 sco：

Invoke-WebRequest 'https://sco.sensecore.cn/registry/sco/install.ps1' -UseBasicParsing | Select-Object -Expand Content | powershell ; $Env:Path += [IO.Path]::PathSeparator + "$Env:USERPROFILE\.sco\bin"

安装成功之后，会有如下类似的提示信息：

SenseCore Command Line Interface: 
Version:          v1.0.1-dev.34.gf8dc37c
Go Version:       go version go1.21.1 linux/amd64
Git Commit:       f8dc37cef6005a3a7adcc03c94cd149bd63ec822
Build Time (UTC): 2023-12-18 01:08:04

PowerShell 下的执行策略问题，参考：about_Execution_Policies。

初始化​

安装 sco 之后，运行 sco init 来完成 sco 的初始化步骤。您可以通过运行 sco init 来更改设置或创建新的配置。

sco init 会完成以下配置：

  • 配置 AccessKey ID 和 AccessKey Secret
  • 选择可用区

配置管理​

配置是一组指定的 sco 属性。这些属性是键值对，分成多个部分，用于管理 sco 的行为。

配置存储在用户配置目录中。Linux 和 MacOS 系统上，默认用户配置目录为 ~/.config/sco。Windows 系统上，默认用户配置目录为 %USERPROFILE%\.config\sco。

如果您有多个配置，可以选择在这些配置之间切换。您也可以在在运行命令时，通过 --profile 标志指定其它的配置。

创建配置​

如果需要创建配置，可以运行 sco config profiles create。配置创建之后会默认激活。

sco config profiles create [NAME]

激活配置​

如果您有多个配置，只能有一个配置处于激活状态。

如果需要激活新的配置，可以运行 scon config profiles activate：

sco config profiles activate [NAME]

sco config list 命令可以用来查看当前已激活配置的属性。

如果需要更改某个命令执行时的配置，可以使用 --profile 标识：

sco srm subscriptions list --profile [PROFILE_NAME]

列出配置​

如果需要列出 sco 的所有配置，可以运行 sco config profiles list：

sco config profiles list

sco 会列出所有配置并显示哪个配置处于激活状态：

NAME       IS_ACTIVE  USERNAME   ACCESS_KEY_ID                     ZONE
default    False      user1      6DF253F796E24CBF99FF16F678F85627  cn-sh-01a
profile-1  False      user1      FB328F12D1AB4CC7B31464133A68C2C4  cn-sh-01b
profile-2  True       user1      5C03F435FB264B94BDEB440B067EE2DD  cn-sh-01b

设置配置属性​

如需设置和取消设置当前激活配置中的属性，可以运行 sco config set 和 sco config unset：

sco config set subscription [SUBSCRIPTION_NAME]
sco config unset subscription

查看配置属性​

如需查看配置中的属性，可以运行 sco config profiles describe：

sco config profiles describe [PROFILE_NAME]

如果需要查看当前激活配置中的属性，可以运行 sco config list：

sco config list

sco 会显示配置属性：

access_key_id = '6DF253F796E24CBF99FF16F678F85627'
access_key_secret = '******'
username = 'user1'
zone = 'cn-sh-01a'

Your active profile is: [default]

删除配置​

如需删除配置，请运行 sco config profiles delete：

sco config profiles delete [PROFILE_NAME]

您无法直接删除当前激活配置。如果需要删除当前激活配置，需要先通过 sco cofnig profiles activate 命令激活其它的配置。

配置属性管理​

配置属性用来管理 sco 的行为。sco 中的一些标志与 sco 的配置属性语义相同。比如 sco 支持 --subscription 标志 和 subscription 属性。当两者都设置时，标志的优先级高于属性。

列出配置属性​

如果需要查看当前激活配置中的属性，可以运行 sco config list：

sco config list

sco 会显示配置属性：

access_key_id = '6DF253F796E24CBF99FF16F678F85627'
access_key_secret = '******'
username = 'user1'
zone = 'cn-sh-01a'

Your active profile is: [default]

设置配置属性​

如需设置当前激活配置中的属性，可以运行 sco config set：

sco config set subscription [SUBSCRIPTION_NAME]

如需设置 core 部分之外的属性，您必须先指定相应部分，后跟英文句点，然后再指定属性名称。比如设置 aec2 部分的 subscription 属性：

sco config set aec2.subscription [SUBSCRIPTION_NAME]

取消配置属性​

如需取消当前激活配置中的属性，可以使用 sco config unset：

sco config unset subscription

组件管理​

sco 组件提供了对应 sco 子产品的命令行操作。您可以根据自己的需求列出、安装、更新和移除 sco 组件。

列出组件​

如需查看可用的组件以及当前安装的组件的列表，请运行 sco components list：

sco components list

安装组件​

如需安装 sco 组件，请运行 sco components install：

sco components install [COMPONENT_NAME]

你也可以执行以下命令，来一次安装所有组件。

sco components install all

升级组件​

使用 sco components upgrade 命令将所有已安装的组件升级为最新版本：

sco components upgrade

移除组件​

使用 sco components remove 命令移除指定的组件：

sco components remove [COMPONENT_NAME]

更新组件列表​

使用 sco components update 命令来更新 sco 组件列表：

sco components update