# ModelArts CLI命令功能介绍
#### 功能介绍
ModelArts CLI，即ModelArts命令行工具，是一个跨平台命令行工具，用于连接ModelArts服务并在ModelArts资源上执行管理命令。用户可以使用交互式命令行提示符或脚本通过终端执行命令。为了方便理解，下面将ModelArts CLI统称为ma-cli。ma-cli支持用户在ModelArts Notebook及线下虚拟机中与云端服务交互，使用ma-cli命令可以实现命令自动补全、鉴权、镜像构建、提交ModelArts训练作业、提交DLI Spark作业、OBS数据复制等。
#### 使用场景
- ma-cli已经集成在ModelArts开发环境Notebook中，可以直接使用。 登录[ModelArts管理控制台](https://console.huaweicloud.com/modelarts/)，在左侧导航栏按需选择以下操作。关于如何打开Terminal，请参见[在JupyterLab中新建Terminal](https://support.huaweicloud.com/devtool-modelarts/devtool-modelarts_0013.html#ZH-CN_TOPIC_0000001402157208__section35271643173218)。
  - 新版控制台：在"模型开发与训练 \> Notebook"中创建Notebook实例，打开Terminal，使用ma-cli命令。
  
  - 旧版控制台：在"开发空间 \> Notebook"中创建Notebook实例，打开Terminal，使用ma-cli命令。
   
- ma-cli在本地Windows/Linux环境中需要安装后在本地Terminal中使用。安装步骤具体可参考[（可选）本地安装ma-cli](https://support.huaweicloud.com/devtool-modelarts/devtool-modelarts_0305.html)。
  ![](https://support.huaweicloud.com/devtool-modelarts/public_sys-resources/note_3.0-zh-cn.png)
  - ma-cli不支持在git-bash上使用。
  
  - 推荐使用Linux Bash、ZSH、Fish，WSL或PowerShell等Terminal。在使用过程中，注意您的敏感信息数据保护，避免敏感信息泄露。
    
 
#### 命令预览
```
$ ma-cli -h
Usage: ma-cli [OPTIONS] COMMAND [ARGS]...
Options:
  -V, -v, --version       1.2.1
  -C, --config-file TEXT  Configure file path for authorization.
  -D, --debug             Debug Mode. Shows full stack trace when error occurs.
  -P, --profile TEXT      CLI connection profile to use. The default profile is "DEFAULT".
  -h, -H, --help          Show this message and exit.
Commands:
  configure        Configures authentication and endpoints info for the CLI.
  image            Support get registered image list、register or unregister image、debug image, build image in Notebook.
  obs-copy         Copy file or directory between OBS and local path.
  ma-job           ModelArts job submission and query job details.
  dli-job          DLI spark job submission and query job details.
  auto-completion  Auto complete ma-cli command in terminal, support "bash(default)/zsh/fish".
```
其中，-C、-D、-P、-h参数属于全局可选参数。
- -C表示在执行此命令时可以手动指定鉴权配置文件，默认使用\~/.modelarts/ma-cli-profile.yaml配置文件；
- -P表示鉴权文件中的某一组鉴权信息，默认是DEFAULT；
- -D表示是否开启debug模式（默认关闭），当开启debug模式后，命令的报错堆栈信息将会打印出来，否则只会打印报错信息；
- -h表示显示命令的帮助提示信息。
#### 命令说明
表1ma-cli支持的命令 
| **命令**                                                                                           | **命令详情**                       |
|:---|:---|
| [auto-completion](https://support.huaweicloud.com/devtool-modelarts/devtool-modelarts_0306.html) | 命令自动补全。                        |
| [configure](https://support.huaweicloud.com/devtool-modelarts/devtool-modelarts_0307.html)       | ma-cli鉴权命令，支持用户名密码、AK/SK。      |
| [image](https://support.huaweicloud.com/devtool-modelarts/devtool-modelarts_0309.html)           | ModelArts镜像构建、镜像注册、查询已注册镜像信息等。 |
| [ma-job](https://support.huaweicloud.com/devtool-modelarts/devtool-modelarts_0320.html)          | ModelArts训练作业管理，包含作业提交、资源查询等。  |
| [dli-job](https://support.huaweicloud.com/devtool-modelarts/devtool-modelarts_0329.html)         | DLI Spark任务提交及资源管理。            |
| [obs-copy](https://support.huaweicloud.com/devtool-modelarts/devtool-modelarts_0337.html)        | 本地和OBS文件/文件夹间的相互复制。            |