OpenWhisk CLI 技术文档

1. 安装指南

1.1 下载已发布的二进制文件

OpenWhisk CLI 提供了适用于多种操作系统和架构的二进制文件，用户可以直接从项目的 GitHub releases 页面下载。

支持的操作系统和架构组合如下：

操作系统	架构
Linux	i386, AMD64, ARM, ARM64, PPC64 (Power), S/390 和 IBM Z
macOS (Darwin)	386, AMD64
Windows	386, AMD64

注意：macOS 的 32 位 (386) 版本在 Go 1.15 及以上版本中不再提供。

1.2 从源码构建

1.2.1 GoLang 环境设置

OpenWhisk CLI 是一个 GoLang 程序，因此首先需要在本地机器上安装 GoLang。建议使用 Go 1.15 或更高版本。确保 $GOPATH 环境变量已正确配置。

1.2.2 下载源码

使用 git clone 命令从 GitHub 下载源码：

git clone [e-mail]:apache/openwhisk-cli

如果需要特定版本的代码，可以使用 --branch <tag> 标志指定版本标签。例如，下载 1.1.0 版本的源码：

git clone --branch 1.1.0 [e-mail]:apache/openwhisk-cli

1.2.3 使用 go build 构建

进入项目目录并使用 go build 命令构建二进制文件：

go build -o wsk

这将生成一个名为 wsk 的可执行文件，适用于当前操作系统和架构。

1.2.4 使用 Gradle 构建

项目包含一个 Gradle Wrapper，可以通过 ./gradlew 命令进行构建。首先需要安装 Java JDK 8 或更高版本。

克隆项目后，进入项目目录并运行以下命令以构建所有支持的操作系统和架构的二进制文件：

./gradlew goBuild

构建成功后，wsk 二进制文件将位于 build/<os>-<architecture>/ 目录下。

2. 项目使用说明

2.1 运行 wsk CLI

将 wsk 二进制文件复制到任意文件夹，并将其路径添加到系统的 PATH 环境变量中，即可在系统任意位置运行 OpenWhisk CLI 命令。

获取 CLI 命令帮助信息：

wsk --help

获取调试信息：

wsk --debug

3. 项目 API 使用文档

OpenWhisk CLI 提供了丰富的命令行接口，用于与 OpenWhisk 服务进行交互。以下是一些常用命令的示例：

• 列出所有动作：

  wsk action list
  

• 创建新动作：

  wsk action create myAction myAction.js
  

• 调用动作：

  wsk action invoke myAction --blocking
  

• 获取动作详情：

  wsk action get myAction
  

• 删除动作：

  wsk action delete myAction
  

更多命令和详细用法可以通过 wsk --help 查看。

4. 项目安装方式

4.1 直接下载二进制文件

用户可以直接从 GitHub releases 页面下载适用于其操作系统和架构的二进制文件，并将其添加到系统的 PATH 环境变量中。

4.2 从源码构建

用户可以通过以下步骤从源码构建 OpenWhisk CLI：

1. 安装 GoLang 并配置 $GOPATH。
2. 使用 git clone 命令下载源码。
3. 使用 go build 或 ./gradlew 命令构建二进制文件。

构建完成后，生成的 wsk 二进制文件即可用于与 OpenWhisk 服务进行交互。