UNPKG

qubit-cli/README.md

Version:

1.75 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
7
8A client to facilitate local development of experiences for the qubit platform
9
10## Features
11
12_Develop experiences locally using your preferred development environment:_
13
14- use your local editor/IDE of choice to write experience code
15- use your own workflow and versioning tools
16- write and run local unit tests
17
18_Iterate quickly using the built in live previewing and hot reloading server:_
19
20- built in experience server for instant preview on any website
21- live hot reloading
22
23_Automate your workflow by interacting with the platform from the command line:_
24
25- create new experiences or clone existing ones
26- push remote changes to the platform
27- pull remote changes from the platform
28- revert or diff with previous iterations of the experience
29- publish | pause | resume your experience
30- CI integration
31
32## Installation
33
34`npm install -g qubit-cli`
35
36## Windows
37
38Please ensure you have a recent version of `openssl` installed (e.g. 1.1.1)
39
40You can find and install `openssl` using the `cygwin` installer or from https://slproweb.com/products/Win32OpenSSL.htmls
41
42Please also ensure that the `openssl` executable is available on the system path
43
44## Setup
45
46Run `qubit extension` and then drag the chrome-extension folder into your chrome extensions pane
47
48## Docs
49
50See 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
8	`A client to facilitate local development of experiences for the qubit platform`
9
10	`## Features`
11
12	`_Develop experiences locally using your preferred development environment:_`
13
14	`- use your local editor/IDE of choice to write experience code`
15	`- use your own workflow and versioning tools`
16	`- write and run local unit tests`
17
18	`_Iterate quickly using the built in live previewing and hot reloading server:_`
19
20	`- built in experience server for instant preview on any website`
21	`- live hot reloading`
22
23	`_Automate your workflow by interacting with the platform from the command line:_`
24
25	`- create new experiences or clone existing ones`
26	`- push remote changes to the platform`
27	`- pull remote changes from the platform`
28	`- revert or diff with previous iterations of the experience`
29	`- publish \| pause \| resume your experience`
30	`- CI integration`
31
32	`## Installation`
33
34	`npm install -g qubit-cli`
35
36	`## Windows`
37
38	Please ensure you have a recent version of `openssl` installed (e.g. 1.1.1)
39
40	You can find and install `openssl` using the `cygwin` installer or from https://slproweb.com/products/Win32OpenSSL.htmls
41
42	Please also ensure that the `openssl` executable is available on the system path
43
44	`## Setup`
45
46	Run `qubit extension` and then drag the chrome-extension folder into your chrome extensions pane
47
48	`## Docs`
49
50	`See https://docs.qubit.com/content/developers/cli-overview`