Skip to content
This repository has been archived by the owner on Jul 2, 2018. It is now read-only.

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
robhrt7 committed Jul 1, 2015
1 parent 866cc17 commit 328e83a
Showing 1 changed file with 80 additions and 40 deletions.
120 changes: 80 additions & 40 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,65 +51,89 @@ Scaffold new widgets, containers and other Backbase CXP components.

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

``` shell
$ bb generate widget
```
bb generate widget
```

``` shell
$ bb generate container
```
bb generate container
```

#### Launchpad 0.12 Generators

For Launchpad 0.12 development, please use the following commands:

``` shell
$ bb generate lp12-widget
```
bb generate lp12-widget
```

``` shell
$ bb generate lp12-module
```
bb generate lp12-module
```

Read more about generate API [here](/docs/generate.md).

### Export

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

### Import

```
bb import [OPTIONS]
```

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

#### Options
Expand All @@ -120,10 +144,17 @@ Imports portal exported by export tool. It supports importing of chunked exports

#### Examples

Imports portal from myPortal.xml
`bb import --target myPortal.xml`
Imports bb export chunked portal from chunked dir
`bb import --target chunked`
Imports portal from myPortal.xml

```
bb import --target myPortal.xml
```

Imports bb export chunked portal from chunked dir

```
bb import --target chunked
```

### Sync

Expand Down Expand Up @@ -226,22 +257,31 @@ where `package_name` will be the name of the package read from `bower.json` or `

### Install

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

```
Usage: bb install [OPTIONS]
bb install <bower-endpoint> [<bower-endpoint> ..] [OPTIONS]
bb install [OPTIONS]
bb install <bower-endpoint> [<bower-endpoint> ..] [OPTIONS]
```

Also accepts `bower install` arguments like --save, -save-dev, --production, check `bower install -h`.
Wraps a `bower install` and applies additional options like `requirejs-conf` generation and server catalog update.

Options: -short, --name <type> default description
#### Options

```
-C, --catalog <boolean> false Upload components to CXP via REST after install.
-v, --verbose <boolean> false Enable verbose logging mode.
--base-url <string> path/to/bower_comp Web path to bower components directory (also configurable from .bbrc).
--require-confs <string> 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`.

#### Exampels

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


## Configuration

Expand Down

0 comments on commit 328e83a

Please sign in to comment.