bb-cli-nightly

Backbase CLI tools
===================


Early preview, nightly version. Unstable.

[Nightly] Command line tools for working with Backbase CXP.

Scaffold new components, navigate through archetypes and work with REST API helpers using clean, automated workflow.

Install

``shell
npm i bb-cli-nightly --global
`

$3

Each command have it's own help section bb COMMAND -h, filled with all information about arguments, default values and examples.

Global help is also available:

`
bb -h
`

$3

By typing a simple command you can now check out a new mvn archetype by executing the command:

`
bb archetype
`

Or use it's short version:

`
bb arch
`

Read more about Archetype API here.

$3

Scaffold new widgets, containers and other Backbase CXP components.

In directory where you run the command, tool will generate starting template for chosen item.

`
bb generate widget
`

`
bb generate container
`

#### Launchpad 0.12 Generators

For Launchpad 0.12 development, please use the following commands:

`
bb generate lp12-widget
`

`
bb generate lp12-module
`

Read more about generate API here.

$3

`
bb export [OPTIONS]
`

Exports portal. Chunk option will divide export into separate xml files grouped by item type.
It will also pretty print xml files and sort items and properties alphabetically on name.
bb rest options for defining host, port, contaxt, username and password also work. Or you can define those properties inside .bbrc file.

#### Options

`
-s, --save portal-name.ext File or dir to save the export to.
-t, --type model What to export: model(portal without content), portal, widget, container
-n, --name Name of the widget or container to export.
-C, --item-context [BBHOST] Context of the widget or container that is to be exported.
--pretty true Prettify the output.
--sanitize true Sanitize the output.
-k, --chunk false Parse output and chunk it into multiple files.
-f, --force false Force overwrite.
`

#### Examples

Outputs prettified, sorted xml file.
`
bb export
`

Saves export to myPortal.xml
`
bb export --save myPortal.xml
`

Chunks export to myPortal dir
`
bb export --portal my-portal --save myPortal -k
`

Saves export including content to retail.zip
`
bb export --type portal --save retail.zip
`

Chunks full export into retail dir
`
bb export --type portal --portal retail-banking --save retail -k
`

Chunks widget-accounts export to accounts dir
`
bb export -s accounts --type widget --name widget-accounts -k
`

$3

`
bb import [OPTIONS]
`

Imports portal exported by export tool. It supports importing of chunked exports.

#### Options

`
-t, --target File or dir to import.
`

#### Examples

Imports portal from myPortal.xml

`
bb import --target myPortal.xml
`

Imports bb export chunked portal from chunked dir

`
bb import --target chunked
`

$3

Syncs local XML model with remote.
Run it in the component folder to sync with CXP. It parser the first *.xml file or defined one from --file argument.
In case that xml file does not exist, it can create one by saving the response from the REST API call.
This call will be made on server catalog for the item defined by --save parameter.
In case that --save is undefined, it will search for bower.json file and use the name of the package as item name (handy for LP widgets).

`
bb sync [OPTIONS] Syncs local XML model with remote.
`

#### Options

`
-short, --name (type) default description

-f, --file (string) first xml file A file to target.
-c, --context (string) portalserver Portal server context (for other options use .bbrc).
-s, --save (string) Name of the server item which model should be exported to a file.
-y, --yes (boolean) Disables dialogs.
-v, --verbose false Prints detailed output.
`

$3

Command line version of Backbase Rest API library for low level and precise tasks.

`
bb rest [OPTIONS]
`

#### Options

`
-short, --name default description

-H, --host localhost The host name of the server running portal foundation.
-P, --port 7777 The port of the server running portal foundation.
-c, --context portalserver The application context of the portal foundation.
-u, --username admin Username.
-w, --password admin Password.
-p, --portal Name of the portal on the server to target.
-t, --target server Context target: server, portal, catalog, portalCatalog, page, container, widget, link, template, user, group, audit or cache.
-T, --target-arg Target arguments. When there are more arguments, pass JSON array.
-m, --method get HTTP method to use: get, post, put or delete.
-f, --file Path of the file to send. Or JSON string when using mosaic-xml-js.
-r, --rights Targets context rights.
-g, --tags Targets context tags.
-q, --query Sets query string.
-x, --empty-cache Shortcut to empty all server caches.
-v, --verbose Prints detailed output.
-s, --save Saves response into file.
`

$3

Symlinks source directory to defined target.

Use this command to symlink clone of your widget/module working repo to the working portal.

`
bb ln --source /component/path --target /path/to/portalserver/static/dir/
`

#### Helpers

This command also supports conventions used in Launchpad and ES. For example:

If --lp-trunk path is set, target will be:

{lp path}/launchpad-bundles/static/launchpad/{bundle}/widgets/{package name}

If --lp-portal path is set, target will be:

{cxp portal path}/src/main/webapp/static/launchpad/{bundle}/widgets/{package name}

As LP convention, if package name starts with widget- it will be stripped out when creating a symlink.

If --portal path is set, target will be:

{cxp portal path}/src/main/webapp/static/widgets/{package name}

where package_name will be the name of the package read from bower.json or package.json.

#### Options

`
-short, --name default description

-s, --source current directory Path to source directory.
-t, --target Path to directory in which to (un)link a source.
--lp-trunk Path to launchpad-trunk.
--lp-portal Path to portalserver containing lp.
--portal Path to portalserver.
-f, --force Force removal of the target.
-u, --unlink Remove symlink.
`

$3

`
bb install [OPTIONS]
bb install [ ..] [OPTIONS]
`

Wraps a bower install and applies additional options like requirejs-conf generation and server catalog update.

#### Options

`
-C, --catalog false Upload components to CXP via REST after install.
-v, --verbose false Enable verbose logging mode.
--base-url path/to/bower_comp Web path to bower components directory (also configurable from .bbrc).
--require-confs Coma seperated list of relative paths to existing require configuration (also configurable from .bbrc).
`

Also accepts bower install arguments like --save, -save-dev, --production, check bower install -h.

#### Examples

`
bb install jquery --save
bb install todo-widget -C --save
`

Configuration

All REST based commands support .bbrc configuration. Running the command in the folder with .bbrc file or in one of the child folders with defined configuration, CLI will use it to override default options.

Example of .bbrc (must contain valid JSON) contents:

`json
{
"context": "/",
"port": "7778",
"username": "me",
"password": "it's me"
}
`

$3

If CXP based project has custom configuration for context or admin credentials, put custom .bbrc into the root folder, so CLI could use custom defaults.

`
/project
.bbrc
config
some.xml
`

Where .bbrc file contains this conf:

`
{
"context": "/",
"username": "me",
"password": "it's me"
}
`

Now running bb import from /project/config dir, CLI will use defined REST configuration with overriden context` and user credentials.

API docs

Programmatic API.

* config
* portalUtils

___

Copyright © 2015 Backbase B.V.