add doc for command aliases

star-whale · Oct 18, 2022 · ccc003a · ccc003a
1 parent 9c2f7d8
commit ccc003a
Show file tree

Hide file tree

Showing 7 changed files with 78 additions and 65 deletions.
diff --git a/docs/i18n/zh/docusaurus-plugin-content-docs/current/reference/cli/basic.md b/docs/i18n/zh/docusaurus-plugin-content-docs/current/reference/cli/basic.md
@@ -28,3 +28,14 @@ swcli -o json dataset diff  mnist/version/gfrtmobxha3w  mnist/version/latest
 
 swcli -o json model list
 ```
+
+swcli支持子命令的前缀简写输入，如果遇到冲突会有相关提示：
+
+```bash
+swcli r -h
+swcli ru -h
+swcli run -h
+swcli runt -h
+```
+
+上面四个命令等价于 `swcli runtime -h`。
diff --git a/docs/i18n/zh/docusaurus-plugin-content-docs/current/reference/cli/dataset.md b/docs/i18n/zh/docusaurus-plugin-content-docs/current/reference/cli/dataset.md
@@ -14,18 +14,18 @@ dataset命令提供适用于Standalone Instance和Cloud Instance的Starwhale Dat
 
 dataset包含如下子命令：
 
-|Command|Standalone|Cloud|
-|-------|----------|-----|
-|`build`|✅|❌|
-|`copy`|✅|✅|
-|`diff`|✅|❌|
-|`history`|✅|✅|
-|`info`|✅|✅|
-|`list`|✅|✅|
-|`recover`|✅|✅|
-|`remove`|✅|✅|
-|`summary`|✅|✅|
-|`tag`|✅|❌|
+|命令|别名|Standalone|Cloud|
+|---|----|----------|-----|
+|build||✅|❌|
+|copy|cp|✅|✅|
+|diff||✅|❌|
+|history||✅|✅|
+|info||✅|✅|
+|list|ls|✅|✅|
+|recover||✅|✅|
+|remove|rm|✅|✅|
+|summary||✅|✅|
+|tag||✅|❌|
 
 ## 2. 构建数据集
 
@@ -130,6 +130,8 @@ swcli dataset list [OPTIONS]
 |`--page`||❌|Integer|1|Cloud Instance中分页显示中page序号。|
 |`--size`||❌|Integer|20|Cloud Instance中分页显示中每页数量。|
 
+`dataset list` 的alias命令为 `dataset ls`。
+
 ## 9. 删除数据集
 
 ```bash

diff --git a/docs/i18n/zh/docusaurus-plugin-content-docs/current/reference/cli/eval.md b/docs/i18n/zh/docusaurus-plugin-content-docs/current/reference/cli/eval.md
@@ -14,17 +14,17 @@ eval命令提供适用于Standalone Instance和Cloud Instance的模型评测管
 
 eval命令包含如下子命令：
 
-|命令|Standalone|Cloud|
-|-------|----------|-----|
-|run|✅|✅|
-|compare|✅|❌|
-|info|✅|✅|
-|list|✅|✅|
-|remove|✅|✅|
-|recover|✅|✅|
-|pause|✅|✅|
-|cancel|✅|✅|
-|resume|✅|✅|
+|命令|别名|Standalone|Cloud|
+|---|---|----------|-----|
+|run||✅|✅|
+|compare|cmp|✅|❌|
+|info||✅|✅|
+|list|ls|✅|✅|
+|remove|rm|✅|✅|
+|recover||✅|✅|
+|pause||✅|✅|
+|cancel||✅|✅|
+|resume||✅|✅|
 
 ## 2. 评测模型
 

diff --git a/docs/i18n/zh/docusaurus-plugin-content-docs/current/reference/cli/instance.md b/docs/i18n/zh/docusaurus-plugin-content-docs/current/reference/cli/instance.md
@@ -18,13 +18,13 @@ instance命令提供基本的Instance管理，包括登陆、查看本地Instanc
 
 instance包含如下子命令：
 
-|Command|Standalone|Cloud|
-|-------|----------|-----|
-|login|❌|✅|
-|logout|❌|✅|
-|select|✅|✅|
-|list|✅|✅|
-|info|✅|✅|
+|命令|别名|Standalone|Cloud|
+|---|---|----------|-----|
+|login||❌|✅|
+|logout||❌|✅|
+|select|use|✅|✅|
+|list|ls|✅|✅|
+|info||✅|✅|
 
 ## 2. 登陆Instance
 

diff --git a/docs/i18n/zh/docusaurus-plugin-content-docs/current/reference/cli/model.md b/docs/i18n/zh/docusaurus-plugin-content-docs/current/reference/cli/model.md
@@ -14,18 +14,18 @@ model命令提供适用于Standalone Instance和Cloud Instance的Starwhale Model
 
 model包含如下子命令：
 
-|命令|Standalone|Cloud|
-|-------|----------|-----|
-|`build`|✅|❌|
-|`copy`|✅|✅|
-|`eval`|✅|❌|
-|`extract`|✅|❌|
-|`history`|✅|✅|
-|`info`|✅|✅|
-|`list`|✅|✅|
-|`recover`|✅|✅|
-|`remove`|✅|✅|
-|`tag`|✅|❌|
+|命令|别名|Standalone|Cloud|
+|---|---|----------|-----|
+|build||✅|❌|
+|copy|cp|✅|✅|
+|eval||✅|❌|
+|extract||✅|❌|
+|history||✅|✅|
+|info||✅|✅|
+|list|ls|✅|✅|
+|recover||✅|✅|
+|remove|rm|✅|✅|
+|tag||✅|❌|
 
 ## 2. 构建模型包
 

diff --git a/docs/i18n/zh/docusaurus-plugin-content-docs/current/reference/cli/project.md b/docs/i18n/zh/docusaurus-plugin-content-docs/current/reference/cli/project.md
@@ -14,14 +14,14 @@ project命令提供适用于Standalone Instance和Cloud Instance的Starwhale Pro
 
 project包含如下子命令：
 
-|命令|Standalone|Cloud|
+|命令|别名|Standalone|Cloud|
 |-------|----------|-----|
-|create|✅|✅|
-|info|✅|✅|
-|list|✅|✅|
-|remove|✅|✅|
-|recover|✅|✅|
-|select|✅|✅|
+|create|new,add|✅|✅|
+|info||✅|✅|
+|list|ls|✅|✅|
+|remove|rm|✅|✅|
+|recover||✅|✅|
+|select|use|✅|✅|
 
 ## 2. 创建Project
 

diff --git a/docs/i18n/zh/docusaurus-plugin-content-docs/current/reference/cli/runtime.md b/docs/i18n/zh/docusaurus-plugin-content-docs/current/reference/cli/runtime.md
@@ -14,22 +14,22 @@ runtime命令提供适用于Standalone Instance和Cloud Instance的Starwhale Run
 
 runtime包含如下子命令：
 
-|Command|Standalone|Cloud|
-|-------|----------|-----|
-|`activate`|✅|❌|
-|`build`|✅|❌|
-|`copy`|✅|✅|
-|`dockerize`|✅|❌|
-|`extract`|✅|❌|
-|`history`|✅|✅|
-|`info`|✅|✅|
-|`list`|✅|✅|
-|`lock`|✅|❌|
-|`quickstart`|✅|❌|
-|`recover`|✅|✅|
-|`remove`|✅|✅|
-|`restore`|✅|❌|
-|`tag`|✅|❌|
+|命令|别名|Standalone|Cloud|
+|----|---|----------|-----|
+|activate|actv|✅|❌|
+|build||✅|❌|
+|copy|cp|✅|✅|
+|dockerize||✅|❌|
+|extract||✅|❌|
+|history||✅|✅|
+|info||✅|✅|
+|list|ls|✅|✅|
+|lock||✅|❌|
+|quickstart|qs|✅|❌|
+|recover||✅|✅|
+|remove|rm|✅|✅|
+|restore||✅|❌|
+|tag||✅|❌|
 
 ## 2. 激活Runtime