Skip to content

Latest commit

 

History

History
71 lines (50 loc) · 1.39 KB

DEVELOPMENT.md

File metadata and controls

71 lines (50 loc) · 1.39 KB

Development Notes

Initial setup

$ git clone git@github.com:SkygearIO/skycli.git
$ cd skycli
$ npm install
$ npm link

Verify the initial setup by running skycli.

$ skycli version

Build source

This command will watch the source directory for changes and automatically update the built files.

$ npm start

Alternatively, you can run npm run skycli to build source and then run skycli.

There is an example config file in example/demo which can be used for development. You may also scaffold apps in example, they are ignored in git.

$ cd example/demo
# e.g. deploy cloud code
$ skycli app deploy

Options for development

The command line interface has a developer mode that shows additional information when running skycli help. This can be achieved by running the program with SKYCLI_DEVELOPER_MODE environment variable set to 1.

$ SKYCLI_DEVELOPER_MODE=1 skycli help

You can also run skycli with debug option to print debug information.

$ skycli --debug help
$ SKYCLI_DEBUG=true skycli help  # Alternative usage

Publish

Bump version number to next version:

$ npm version minor  # 0.1.0 > 0.2.0
$ npm version patch  # 0.1.0 > 0.1.1

Publish to npm. This will also create a pull request on SkygearIO/homebrew-tap.

$ npm publish

Accepted the pull request to update homebrew tap.