[doc] new commands.

This commit is contained in:
Romain Dorgueil
2017-09-30 11:45:13 +02:00
parent c6cde93f4e
commit 7fb572ec90

View File

@ -1,6 +1,21 @@
Command-line
============
Bonobo Convert
::::::::::::::
Build a simple bonobo graph with one reader and one writer, then execute it, allowing to use bonobo in "no code" mode
for simple file format conversions.
Syntax: `bonobo convert [-r reader] input_filename [-w writer] output_filename`
.. todo::
add a way to override default options of reader/writers, add a way to add "filters", for example this could be used
to read from csv and write to csv too (or other format) but adding a geocoder filter that would add some fields.
Bonobo Init
:::::::::::
@ -8,7 +23,17 @@ Create an empty project, ready to use bonobo.
Syntax: `bonobo init`
Requires `edgy.project`.
Requires `cookiecutter`.
Bonobo Inspect
::::::::::::::
Inspects a bonobo graph source files. For now, only support graphviz output.
Syntax: `bonobo inspect [--graph|-g] filename`
Requires graphviz if you want to generate an actual graph picture, although the command itself depends on nothing.
Bonobo Run
@ -20,6 +45,7 @@ Syntax: `bonobo run [-c cmd | -m mod | file | -] [arg]`
.. todo:: implement -m, check if -c is of any use and if yes, implement it too. Implement args, too.
Bonobo RunC
:::::::::::