CLI reference

This is for:

Developer

In this article

Commands

When using Qubit CLI you will notice it creates and manages a local package.json file.

This file contains a meta field, which is an object containing some experience metadata, as well as some options you can use to affect the environment where your experience is running in preview:

Name Access Description

Name	Access	Description
experienceId	readonly	Stores the experienceId
propertyId	editable	Stores the property_id
iterationId	readonly	Stores the current iterationId
remoteUpdatedAt	readonly	Stores the last known remote updated timestamp so that Qubit CLI can determine whether there are any conflicts
variations	readonly	Stores metadata about the variations belonging to the experience
name	editable	Stores the experience name, if you edit this and push your experiences, the name will be updated
previewUrl	editable	Stores the preview url, if you edit this and push your experiences, the preview URL will be updated
templateData	editable	The configurable content data values passed to your experience at runtime. For convenience, you can be override this during development to see how your experience renders with different values
visitor	editable	Allows you to override visitor attributes returned by getVisitorState which can be convenient for development purposes, for example, to force the visitor to always be on their second session
isPreview	editable	Determines whether your experience should execute in preview mode, alongside other draft experiences, or live mode, alongside other published experiences
include	editable	An array of variationMasterIds to execute along with your own, an empty array to force no other experience to fire, or `false` to force everything to load naturally alongside your experience
exclude	editable	An array of experienceIds to exclude
vertical	editable	Override the default vertical passed to your experience at runtime
tracking_id	editable	Override the default tracking_id passed to your experience at runtime
segments	editable	An array of segment Ids that the visitor is in. These will be used in the `options.isMemberOf()` and `options.getMemberships()` API methods when previewing with Qubit CLI

experienceId

readonly

Stores the experienceId

propertyId

editable

Stores the property_id

iterationId

readonly

Stores the current iterationId

remoteUpdatedAt

readonly

Stores the last known remote updated timestamp so that Qubit CLI can determine whether there are any conflicts

variations

readonly

Stores metadata about the variations belonging to the experience

name

editable

Stores the experience name, if you edit this and push your experiences, the name will be updated

previewUrl

editable

Stores the preview url, if you edit this and push your experiences, the preview URL will be updated

templateData

editable

The configurable content data values passed to your experience at runtime. For convenience, you can be override this during development to see how your experience renders with different values

visitor

editable

Allows you to override visitor attributes returned by getVisitorState which can be convenient for development purposes, for example, to force the visitor to always be on their second session

isPreview

editable

Determines whether your experience should execute in preview mode, alongside other draft experiences, or live mode, alongside other published experiences

include

editable

An array of variationMasterIds to execute along with your own, an empty array to force no other experience to fire, or false to force everything to load naturally alongside your experience

exclude

editable

An array of experienceIds to exclude

vertical

editable

Override the default vertical passed to your experience at runtime

tracking_id

editable

Override the default tracking_id passed to your experience at runtime

segments

editable

An array of segment Ids that the visitor is in. These will be used in the options.isMemberOf() and options.getMemberships() API methods when previewing with Qubit CLI

Commands

Here is a full reference of all the commands available to Qubit CLI:

Name Description

Name	Description
login	Login to the qubit platform
logout	Logout of the qubit platform
scopes	See what scopes you have access to
release [options] [version]	Release a new version of your package
create [propertyId]	Create an experience
clone [url] [propertyId] [experienceId]	Clone an experience
clone-all [propertyId]	Clone all experiences from a given property
publish	Publish an experience
pause	Pause an experience
resume	Resume an experience
templatize	Create a template from an experience
pull	Pull remote changes your local experience
pull [name]	Pull a locally installed template into your local experience
push [options]	Push local changes to the platform
duplicate-experience [destinationPropertyId] [experienceId]	Duplicate an experience
duplicate-variation	Create a copy of the most recent variation in your experience
traffic [options]	Set the control size of an experience
goals <cmd>	List or edit experience goals - with `list` `add` `remove` and `set-primary` being subcommands
diff	Compare local and remote versions of an experience
delete	Delete an experience or variation
status	Check the publish status of an experience
open [page]	Shortcut to open the overview, settings, or editor page for the current experience
link [page]	Shortcut to get a link to the overview, settings, editor, or preview page for the current experience
extension	Open folder containing the Qubit-CLI chrome extension folder, which can be dragged into chrome://extensions to install
token	Generate an authentication token, for example, for use with CI" revoke,"Revoke an authentication token
pre clone [propertyId]	Clone the remote draft pre script for a property into a new subdirectory
pre pull [propertyId] [live/draft]	Pull the remote live/draft (defaults to draft) pre script for a property into your current directory
push [--force]	Push your local pre script for a property to the remote draft
revisions [propertyId]	List the published revisions of a property’s pre script
diff [live/draft]	Diff your local pre script against the remote live/draft
publish [--force]	Publish the remote draft pre script to live

logout

Logout of the qubit platform

scopes

See what scopes you have access to

release [options] [version]

Release a new version of your package

create [propertyId]

Create an experience

clone [url] [propertyId] [experienceId]

Clone an experience

clone-all [propertyId]

Clone all experiences from a given property

publish

Publish an experience

pause

Pause an experience

resume

Resume an experience

templatize

Create a template from an experience

pull

Pull remote changes your local experience

pull [name]

Pull a locally installed template into your local experience

push [options]

Push local changes to the platform

duplicate-experience [destinationPropertyId] [experienceId]

Duplicate an experience

duplicate-variation

Create a copy of the most recent variation in your experience

traffic [options]

Set the control size of an experience

goals <cmd>

List or edit experience goals - with list add remove and set-primary being subcommands

diff

Compare local and remote versions of an experience

delete

Delete an experience or variation

status

Check the publish status of an experience

open [page]

Shortcut to open the overview, settings, or editor page for the current experience

link [page]

Shortcut to get a link to the overview, settings, editor, or preview page for the current experience

extension

Open folder containing the Qubit-CLI chrome extension folder, which can be dragged into chrome://extensions to install

token

Generate an authentication token, for example, for use with CI" revoke,"Revoke an authentication token

pre clone [propertyId]

Clone the remote draft pre script for a property into a new subdirectory

pre pull [propertyId] [live/draft]

Pull the remote live/draft (defaults to draft) pre script for a property into your current directory

push [--force]

Push your local pre script for a property to the remote draft

revisions [propertyId]

List the published revisions of a property’s pre script

diff [live/draft]

Diff your local pre script against the remote live/draft

publish [--force]

Publish the remote draft pre script to live