Interactive CLI

Optic ships with an interactive prompt that you can keep open alongside your IDE. You can start this prompt by running optic without any arguments in your terminal window.

Note The interactive CLI must be started from the root directory of an Optic project or one of its decedents.

Layout

alt

  • Notification Bar: displays status updates and errors from the Optic server.
  • Content: where all the interactive views are displayed (search results, sync info, & the schema editor)
  • Input prompt: type your commands here
  • IDE Status: displays the name of the IDE Optic is currently connected to.

Once the interactive prompt starts it will continue to receive updates from Optic and your IDEs.

If you want to close the prompt press CTRL-C.

Next Steps: CLI Commands