Quick Start

1. Download the CLI#

yarn global add @useoptic/cli
note

Optic requires Node v12+, and we'll install a compatible version as a requirement via your package manager of choice. Depending on your installation method and node version management process, it's possible to get into a state where an incompatible version of Node is running. If you need to check, api --version will tell you both the Optic CLI and Node version running. If you run into an issue here, please let us know.

While that’s downloading πŸ‘‡#

2. Add Optic to your API#

Initialize Optic in your API's root directory:

cd /path/to/api

api init

Follow the on-boarding flow and set up an api start alias:

alt

Explore our docs to learn more about running your tests with Optic, installing the GitBot, and sharing Optic with your team.

Next Step: Configure API Tasks#


How can I get involved in the project?#

Some of the most valuable contributions to an open source project are written in prose, not code. Developers taking the time to share their feedback, perspective, and ideas with the broader community are the oxygen of big projects like Optic.

Get Involved

Who made this?#


Aidan Cunniffe

πŸ“– πŸ’»

devdoshi

πŸ“– πŸ’»

Evan Mallory

πŸ“–

Jaap van Hardeveld

πŸ’» πŸ“–

Ronak Shah

πŸ’» πŸ“–

taraedits

πŸ“–

Lou Manglass

πŸ’» πŸ“–

Nate Meyer

πŸ’»

Tim Gates

πŸ“–

Matthew Hudson

πŸ“–

LaV

πŸ“–

Gaurav Nelson

πŸ“–

Ross Nordstrom

🎨 πŸ’» πŸ›

Kin Lane

πŸ€” πŸ–‹

Viljami Kuosmanen

πŸ€” πŸ–‹

Richard Crowley

πŸ”¬ πŸ€”

dnmtr

πŸ‘€