@zeus-ci/sdk

Zeus JavaScript SDK

JavaScript API client for Zeus.

Installation

The CLI comes as NPM package and can be installed via npm or yarn:

npm install -g @zeus-ci/sdk
yarn add -g @zeus-ci/sdk

Development

This SDK is built with TypeScript. After installing dependencies, your workspace should contain all tools necessary to develop, test and build the project. See package.json for all scripts:

# Install dependencies
yarn

# Run test watchers
yarn test:watch

# Build JavaScript sources
yarn build

We use prettier for auto-formatting and tslint as linter. Both tools can automatically fix a lot of issues for you. To invoke them, simply run:

yarn fix

It is highly recommended to use VSCode and install the suggested extensions. They will configure your IDE to match the coding style, invoke auto formatters every time you save and run tests in the background for you. No need to run the watchers manually.