Blackbox Command Line Interface (CLI)

Synopsis:

bb command [type] [options]

Commands:

addAdds a Blackbox API component of a given type to the project.
deleteDeletes an existing Blackbox API component. The component is identified by its type and name.
generateGenerate code for the specified type.
initInitialises the Blackbox project with a root OpenAPI JSON file named openapi.json and a bb.json config file.
listLists all Blackbox API components of a given type that exist within the project.
updateChanges an existing Blackbox API component. The component is identified by its type and name.

Types:

datatypeA datatype for use by services.
databaseA database access class for a single datatype.
repositoryA datatype repository for storing and loading datatype definitions.
serverA Blackbox server.
serviceA blackbox service.
privilegeUser privilege/permission.

Options:

--all, -aApply operation to all relevant items. E.g. bb delete service -a -n s1 will remove service s1 and any child services.
--datatype, -dThe data type of a service.
--descThe description of the API.
--destThe destination path for generated code.
--file, -fA source file to read in data appropriate to the command and type.
--methods, -mThe HTTP methods to be supported by the service.
--name, -nThe name of the entity being added or modified.
--service, -sThe parent service in the case of sub-services. Defaults to no parent; i.e. a root level service.
--summarySummary for a service.
--title, -tThe title of the API.
--url, -uA source url to read in data appropriate to the command and type.