Skip to main content

Quickstart

What is Optic?​

Optic is an ecosystem composed of:

  • Mobile application: The mobile app securely stores npm secrets, generates OTPs, and sends push notifications.
  • GitHub action: The action opens a new pull request for the release and when the pull request gets merged it publishes a new a new GitHub release and the npm package. It can retrieve One Time Passwords (OTP) for npm by interacting with the mobile app, while it tries to publish to npm.
  • GitHub app: The GitHub App is a helper that creates release pull requests to the requesting repository. This application should be installed on the repositories (or the organization) where you want to use the action.
  • Backend server: The backend server manages app subscriptions and generates Optic tokens.