wsk for Mac

OpenWhisk Command-line Interface wsk

OpenWhisk Command-line Interface (CLI) is a unified tool that provides a consistent interface to interact with OpenWhisk services.

Getting started

Here are some quick links to help you get started: Downloading released binaries for Linux, macOS and Windows Running the wsk CLI executable Building the project - download and build the GoLang source code Contributing to the project - join us!

Downloading released binaries

Executable binaries of the OpenWhisk CLI are available for download on the project's GitHub releases page.

We currently provide binaries for the following Operating Systems (OS) and architecture combinations:

Operating System | Architectures --- | --- Linux | i386, AMD64, ARM, ARM64, PPC64 (Power), S/390 and IBM Z macOS (Darwin) | 3861, AMD64 Windows | 386, AMD64 macOS, 32-bit (386) released versions are not available for builds using Go lang version 1.15 and greater.

We also provide instructions on how to build your own binaries from source code. See Building the project.

Running the wsk CLI

You can copy the wsk binary to any folder, and add the folder to your system PATH in order to run the OpenWhisk CLI command from anywhere on your system. To get the CLI command help, execute the following:

To get CLI command debug information, include the -d, or --debug flag when executing this command.

Building the project

GoLang setup

The Openwhisk CLI is a GoLang program, so you will first need to Download and install GoLang onto your local machine. Note Go version 1.15 or higher is recommended

Make sure your $GOPATH is defined correctly in your environment. For detailed setup of your GoLang development environment, please read How to Write Go Code.

Download the source code from GitHub

As the code is managed using GitHub, it is easiest to retrieve the code using the git clone command.

if you just want to build the code and do not intend to be a Contributor, you can clone the latest code from the Apache repository:

or you can specify a release (tag) if you do not want the latest code by using the --branch flag. For example, you can clone the source code for the tagged 1.1.0 release

You can also pull the code from a fork of the repository. If you intend to become a Contributor to the project, read the section Contributing to the project below on how to setup a fork.

Build using go build

Use the Go utility to build the sh $ go build -o wsk sh $ GOOS=linux GOARCH=amd64 go build -o wsk sh git clone https://github.com/apache/openwhisk-cli sh ./gradlew goBuild sh $ ls build darwin-amd64 linux-amd64 linux-arm64 linux-s390x windows-amd64 linux-386 linux-arm linux-ppc64le windows-386 sh ./gradlew tasks sh Gogradle tasks

buildDarwinAmd64 - Custom go task. buildLinux386 - Custom go task. buildLinuxAmd64 - Custom go task. buildLinuxArm - Custom go task. buildLinuxArm64 - Custom go task. buildLinuxPpc64le - Custom go task. buildLinuxS390x - Custom go task. buildWindows386 - Custom go task.