Skip to content

plonecli.md

Latest commit

 

History

History
125 lines (81 loc) · 3.11 KB

plonecli.md

File metadata and controls

125 lines (81 loc) · 3.11 KB

plonecli

During the after conference sprints in Barcelona, we finally created a command line client for developing Plone packages. The plonecli is mainly a wrapper around mr.bob and bobtemplates.plone, but can also used with other bobtemplates. The plonecli forms the previous work on refactoring and modulizing the bobtemplates.plone templates, into a simple and easy to use command line client.

Features

  • allow bobtemplates to be registered for plonecli
  • list available bobtemplates for the current context
  • standalone and sub templates
  • auto completion of commands and available templates
  • command chaining

Usage

Create a Plone Addon packages

To create a Plone Addon with the plonecli, you can just use the create command:

plonecli create addon src/collective.todos

If you want to know what templates are available, you can either use the -l/--list-templates option or just press TAB-Key twice.

plonecli --list-templates
Available mr.bob templates:
 - buildout
 - addon
  - vocabulary
  - theme
  - content_type
 - theme_package

Example

Create addon

Add a content_type to your Plone Addon

To add a content_type to an existing Plone Addon package, you can just use the add command inside the package:

cd src/collective.todos
plonecli add content_type

The -l/--list-templates and auto completion works also for subtemplates (the add command).

plonecli add
content_type  theme         vocabulary

Add content type

Add a vocabulary to your Plone Addon

To add a Plone vocabulary, you can use the add command with the vocabulary subtemplate:

plonecli add vocabulary

Example

Add vocabulary

Build a Plone Addon

You can use the plonecli also to build the package:

plonecli build

This will run:

virtualenv .
./bin/pip install -r requirements.txt --upgrade
./bin/buildout

in your target directory. You can always run the 3 steps explicit by using the commands virtualenv,requirements, buildout instead of build. If you want to reset your build use the --clean option on build. This will clear your virtualenv before installing the requirements and also running buildout with -n to get the newest versions.

Example

Build

Serve the development Plone site of the package

The plonecli also provides a serve command which will start the Plone instance in foreground and provide a link to open it in the browser:

plonecli serve
RUN: ./bin/instance fg

INFO: Open this in a Web Browser: http://localhost:8080
INFO: You can stop it by pressing CTRL + c

2017-10-30 14:21:01 INFO ZServer HTTP server started at Mon Oct 30 14:21:01 2017
    Hostname: 0.0.0.0
    Port: 8080
...

Combine (chain) commands

You can combine commands like create, build and serve:

plonecli build serve

This will first run all the build steps and then serve the Plone site

Example

Serve