Blackbox Command Line Interface (CLI)
Synopsis:
bb command [type] [options]
Commands:
add | Adds a Blackbox API component of a given type to the project. |
delete | Deletes an existing Blackbox API component. The component is identified by its type and name. |
generate | Generate code for the specified type. |
init | Initialises the Blackbox project with a root OpenAPI JSON file named openapi.json and a bb.json config file. |
list | Lists all Blackbox API components of a given type that exist within the project. |
update | Changes an existing Blackbox API component. The component is identified by its type and name. |
Types:
datatype | A datatype for use by services. |
database | A database access class for a single datatype. |
repository | A datatype repository for storing and loading datatype definitions. |
server | A Blackbox server. |
service | A blackbox service. |
privilege | User privilege/permission. |
Options:
--all, -a | Apply operation to all relevant items. E.g. bb delete service -a -n s1 will remove service s1 and any child services. |
--datatype, -d | The data type of a service. |
--desc | The description of the API. |
--dest | The destination path for generated code. |
--file, -f | A source file to read in data appropriate to the command and type. |
--methods, -m | The HTTP methods to be supported by the service. |
--name, -n | The name of the entity being added or modified. |
--service, -s | The parent service in the case of sub-services. Defaults to no parent; i.e. a root level service. |
--summary | Summary for a service. |
--title, -t | The title of the API. |
--url, -u | A source url to read in data appropriate to the command and type. |