Skip to content

Commit

Permalink
doc: use universal link instead of arm64/amd64
Browse files Browse the repository at this point in the history
  • Loading branch information
JacksonTian authored and peze committed Sep 4, 2023
1 parent 6997341 commit d1ad71c
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 9 deletions.
10 changes: 7 additions & 3 deletions README-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
**注意**:阿里云 CLI 使用 OpenAPI 方式访问云产品,确保您已经开通了要使用的云产品并了解该产品的 OpenAPI 的使用。您可以在[阿里云 OpenAPI 开发者门户](https://next.api.aliyun.com/)查看产品 API 文档,了解 API 的使用方式及参数列表。

## 使用诊断

[Troubleshoot](https://troubleshoot.api.aliyun.com/?source=github_sdk) 提供 OpenAPI 使用诊断服务,通过 `RequestID``报错信息` ,帮助开发者快速定位,为开发者提供解决方案。

## CLI Releases
Expand All @@ -46,8 +47,7 @@ CLI 版本更改说明请参考 [CHANGELOG](./CHANGELOG.md)
下载链接如下 (<img src="https://img.shields.io/github/release/aliyun/aliyun-cli.svg" alt="Latest Stable Version" />):

- [Mac 图形界面安装器](https://aliyuncli.alicdn.com/aliyun-cli-latest.pkg)
- [Mac (AMD64)](https://aliyuncli.alicdn.com/aliyun-cli-macosx-latest-amd64.tgz)
- [Mac (ARM64)](https://aliyuncli.alicdn.com/aliyun-cli-macosx-latest-arm64.tgz)
- [Mac Universal](https://aliyuncli.alicdn.com/aliyun-cli-macosx-latest-universal.tgz)
- [Linux (AMD64)](https://aliyuncli.alicdn.com/aliyun-cli-linux-latest-amd64.tgz)
- [Linux (ARM64)](https://aliyuncli.alicdn.com/aliyun-cli-linux-latest-arm64.tgz)
- [Windows (64 bit)](https://aliyuncli.alicdn.com/aliyun-cli-windows-latest-amd64.zip)
Expand Down Expand Up @@ -99,14 +99,17 @@ Saving profile[akProfile] ...Done.
您可以使用 `--mode External` 指定通过外部程序获取凭证数据,CLI 将会以执行该程序命令并其返回作为凭证来发起调用。

约定:

1. 外部程序输出位置为标准输出
2. 输出为json结构字符串
3. 输出包含关键字段以及凭证字段

关键字段:

- mode: 指定返回凭证类型

各凭证返回结构示例:

- AK

```json
Expand Down Expand Up @@ -149,7 +152,8 @@ Saving profile[akProfile] ...Done.
}
```

#### 示例:
#### 示例

```shell
$ aliyun configure --mode External --profile externalTest
Configuring profile 'externalTest' in 'External' authenticate mode...
Expand Down
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ The Alibaba Cloud CLI is a tool to manage and use Alibaba Cloud resources throug
> **Note**: Alibaba Cloud CLI access the Alibaba Cloud services through OpenAPI. Before using Alibaba Cloud CLI, make sure that you have activated the service to use and known how to use OpenAPI.
## Troubleshoot

[Troubleshoot](https://troubleshoot.api.aliyun.com/?source=github_sdk) Provide OpenAPI diagnosis service to help developers locate quickly and provide solutions for developers through `RequestID` or `error message`.

## CLI Releases
Expand All @@ -44,8 +45,7 @@ The release notes for the CLI can be found in the [CHANGELOG](./CHANGELOG.md)
Download link: (<img src="https://img.shields.io/github/release/aliyun/aliyun-cli.svg" alt="Latest Stable Version" />)

- [Mac GUI Installer](https://aliyuncli.alicdn.com/aliyun-cli-latest.pkg)
- [Mac (AMD64)](https://aliyuncli.alicdn.com/aliyun-cli-macosx-latest-amd64.tgz)
- [Mac (ARM64)](https://aliyuncli.alicdn.com/aliyun-cli-macosx-latest-arm64.tgz)
- [Mac Universal](https://aliyuncli.alicdn.com/aliyun-cli-macosx-latest-universal.tgz)
- [Linux (AMD64)](https://aliyuncli.alicdn.com/aliyun-cli-linux-latest-amd64.tgz)
- [Linux (ARM64)](https://aliyuncli.alicdn.com/aliyun-cli-linux-latest-arm64.tgz)
- [Windows (64 bit)](https://aliyuncli.alicdn.com/aliyun-cli-windows-latest-amd64.zip)
Expand Down Expand Up @@ -96,15 +96,18 @@ The following are supported authentication methods:

You can use `--mode External` to specify to obtain credential data through an external program, and CLI will execute the program command and return it as a credential to initiate the call.

Agreement:
Agreement:

1. The output location of the external program is standard output.
2. The output format is json string.
3. The output contains the key fields required by the CLI and credential fields

Key field:

- mode: Specify the type of credentials returned

Example of the return of each credential type:

- AK

```json
Expand Down Expand Up @@ -147,7 +150,8 @@ Example of the return of each credential type:
}
```

#### Example:
#### Example

```shell
$ aliyun configure --mode External --profile externalTest
Configuring profile 'externalTest' in 'External' authenticate mode...
Expand Down Expand Up @@ -278,11 +282,11 @@ Alibaba Cloud CLI integrates API descriptions for some products, you can get hel

- `aliyun help <product>`: get the API information of a specific product

For example, get help of ECS APIs: `$ aliyun help ecs`
For example, get help of ECS APIs: `$ aliyun help ecs`

- `$ aliyun help <product> <apiName>`: get the detailed API information of a specific APU

For example, get the help information of the CreateInstance API: `aliyun help ecs CreateInstance`
For example, get the help information of the CreateInstance API: `aliyun help ecs CreateInstance`

### Use the `--force` option

Expand Down

0 comments on commit d1ad71c

Please sign in to comment.