Cli

• Install the cli
• Configure autocomplete
• Commands

Install the cli

To install cli, you should type:

npm install oc -g

Configure autocomplete

Autocomplete is supported for Mac and Linux.

To enable it in zsh, you should type:

echo '. <(oc --completion)' >> .zshrc

To enable it in bash, you should type:

oc --completion >> ~/oc.completion.sh
echo 'source ~/oc.completion.sh' >> .bash_profile

After enabling autocomplete you should reload the shell.

Commands

When you type oc in your command line:

oc

you should get the list of available commands:

Usage: oc <command>

command
dev - Runs a local oc test registry in order to develop and test components
init - Creates a new empty component in the current folder
mock - Allows to mock configuration in order to facilitate local development
preview - Runs a test page consuming a component
publish - Publish a component
registry - Shows, adds, removes oc registries to the current project
version - Shows the cli version


Hint: Run -h with any command to show the help

##dev Runs a local oc test registry in order to develop and test components

Usage:

oc dev <dirName> [port] [baseUrl] [--hotReloading=value [--fallbackRegistryUrl=value]]

Parameters:

Name	Description	Choices
dirName	The name of the directory to watch, where the components are stored
port	The port where to start a local oc instance. Default 3000
baseUrl	The base url the component is hosted from. Default http://localhost:port/
hotReloading	Default true, enables or not hot reloading. Note: when hot reloading is set to true, each request to the component will make the registry to create a new instance for the javascript closures to be loaded, while when false the instance will be recycled between components executions	true,false
fallbackRegistryUrl	Url to another registry which will be used by dev registry when component cannot be found in local registry. Example: --fallbackRegistryUrl=http://anotherhost:anotherport/

##init Creates a new empty component in the current folder

Usage:

oc init <componentName> [templateType]

Parameters:

Name	Description	Choices
componentName	The name of the component to create
templateType	The component's template type. Options are jade or handlebars (default).

##mock Allows to mock configuration in order to facilitate local development

Usage:

oc mock <targetType> <targetName> <targetValue>

Parameters:

Name	Description	Choices
targetType	The type of item to mock	plugin
targetName	The item to mock
targetValue	The mocked value (static plugin) or the file to read (dynamic plugin)

##preview Runs a test page consuming a component

Usage:

oc preview <componentHref>

Parameters:

Name	Description	Choices
componentHref	The name of the component to preview

##publish Publish a component

Usage:

oc publish <componentPath>

Parameters:

Name	Description	Choices
componentPath	The path of the component to publish

##registry Shows, adds, removes oc registries to the current project

Usage:

oc registry <command> [parameter]

Parameters:

Name	Description	Choices
command	Action: add, ls, or remove	add,ls,remove
parameter	Parameter to perform the action

##version Shows the cli version

Usage:

oc version