UNPKG

qubit-cli/README.md

Version:

1.74 kBMarkdownView Raw

1[![Codeship Status for qubitdigital/qubit-cli](https://app.codeship.com/projects/638fd7f0-7353-0134-988c-52e76941e580/status?branch=master)](https://app.codeship.com/projects/178849)
2[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
3
4# ![logo](https://user-images.githubusercontent.com/640611/32888373-fbdc7134-cabe-11e7-9b0e-027a49cef8bf.png)
5
6## Qubit-CLI
7A client to facilitate local development of experiences for the qubit platform
8
9## Features
10*Develop experiences locally using your preferred development environment:*
11- use your local editor/IDE of choice to write experience code
12- use your own workflow and versioning tools
13- write and run local unit tests
14
15*Iterate quickly using the built in live previewing and hot reloading server:*
16- built in experience server for instant preview on any website
17- live hot reloading
18
19*Automate your workflow by interacting with the platform from the command line:*
20- create new experiences or clone existing ones
21- push remote changes to the platform
22- pull remote changes from the platform
23- revert or diff with previous iterations of the experience
24- publish | pause | resume your experience
25- CI integration
26
27## Installation
28
29`npm install -g qubit-cli`
30
31
32## Windows
33Please ensure you have a recent version of `openssl` installed (e.g. 1.1.1)
34
35You can find and install `openssl` using the `cygwin` installer or from https://slproweb.com/products/Win32OpenSSL.htmls
36
37Please also ensure that the `openssl` executable is available on the system path
38
39## Setup
40
41Run `qubit extension` and then drag the chrome-extension folder into your chrome extensions pane
42
43## Docs
44See https://docs.qubit.com/content/developers/cli-overview

1	`[![Codeship Status for qubitdigital/qubit-cli](https://app.codeship.com/projects/638fd7f0-7353-0134-988c-52e76941e580/status?branch=master)](https://app.codeship.com/projects/178849)`
2	`[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)`
3
4	`# ![logo](https://user-images.githubusercontent.com/640611/32888373-fbdc7134-cabe-11e7-9b0e-027a49cef8bf.png)`
5
6	`## Qubit-CLI`
7	`A client to facilitate local development of experiences for the qubit platform`
8
9	`## Features`
10	`Develop experiences locally using your preferred development environment:`
11	`- use your local editor/IDE of choice to write experience code`
12	`- use your own workflow and versioning tools`
13	`- write and run local unit tests`
14
15	`Iterate quickly using the built in live previewing and hot reloading server:`
16	`- built in experience server for instant preview on any website`
17	`- live hot reloading`
18
19	`Automate your workflow by interacting with the platform from the command line:`
20	`- create new experiences or clone existing ones`
21	`- push remote changes to the platform`
22	`- pull remote changes from the platform`
23	`- revert or diff with previous iterations of the experience`
24	`- publish \| pause \| resume your experience`
25	`- CI integration`
26
27	`## Installation`
28
29	`npm install -g qubit-cli`
30
31
32	`## Windows`
33	Please ensure you have a recent version of `openssl` installed (e.g. 1.1.1)
34
35	You can find and install `openssl` using the `cygwin` installer or from https://slproweb.com/products/Win32OpenSSL.htmls
36
37	Please also ensure that the `openssl` executable is available on the system path
38
39	`## Setup`
40
41	Run `qubit extension` and then drag the chrome-extension folder into your chrome extensions pane
42
43	`## Docs`
44	`See https://docs.qubit.com/content/developers/cli-overview`