Skip to main content

api help

Provides usage information for api and subcommands. For subcommands that take parameters, such as run and check which take a task name, --help will provide the same information.

Flags & Options#

This command takes no flags and has no options.


For example, to learn more about the init command, use:

api init help


api init --help
add Optic to your API
USAGE  $ api init
OPTIONS  --command=command  --inboundUrl=inboundUrl  --targetUrl=targetUrl

Issues & Contributing#

Having trouble? Open an issue on GitHub

Have an idea for changing this command? Here's where it lives in the repo. PRs welcome!

Need help or want to talk with us about a use case? Join Contributing on Discord