Get Started

We recommend installing Optic with npm. Just run the following command to begin the installation.

npm install optic-cli -g

What am I installing?

  • An Optic language server to interpret your code locally
  • The Optic CLI (added to your path as optic)
  • (optional) Optic plugins for the IDEs on your computer.

Setup Optic Server

Once the optic-cli package installs it will walk you through the process of setting up the Optic server. If this process does not start automatically just run optic from any directory.

  1. Enter your email or press return to skip
  2. Press y to finish the installation.
Welcome to Optic 2.0.0
? Please enter your email:
? Finish Install: Configure local Optic server and install IDE plugins (Y/n) 

This will download a JRE for your operating system (~60mb) and setup the local Optic server.

? Finish Install: Configure local Optic server and install IDE plugins (Y/n) y

Installing local Optic server...
downloading and preparing JRE + Optic Server [========================] 100% 0.0s
Optic Server Installed

You'll then be prompted to install the Optic IDE plugins. These plugins are very lightweight; all they do is forward the filepath, unsaved changes, and the cursor position to the Optic server. We suggest you leave all of them selected and press return

Searching for IDEs...
? Select IDE Plugins to install (Press <space> to select, <a> to toggle all, <i> to invert selection)
❯◉ Atom
 ◉ IntelliJ CE
 ◉ Sublime Text 3
 ◉ VSCode
 ◉ WebStorm

Don't see an IDE you love? Build an open source plugin for it here.

Press return to start the IDE plugin installations. Typically this takes <1 min to complete.

? Select IDE Plugins to install Atom, IntelliJ CE, Sublime Text 3, VSCode, WebStorm
Starting install (this will take a minute)...
VSCode: Success
Atom: Success
WebStorm: Success
Sublime Text 3: Success
IntelliJ CE: Success

Setup Complete!

That's it! You're all setup!

Next Steps