Skip to main content

api spec

spec#

Opens your current API specification. This is a quick way to see the current state of the documentation, or jump in and add detail to the endpoints and fields. The Optic dashboard will be opened in your browser on the Documentation page.

Flags & Options#

This command takes no flags and has no options.

Examples#

To open the documentation for your project, use:

api spec

Which will open your web browsesr to the Optic documentation dashboard

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