Ovok CLI
Create Ovok apps and work with your project from the terminal.
Use create-ovok to start a workspace with Ovok web and mobile apps. Use ovok to forward FHIR and
Signals events to your machine while you develop, and to manage Signals webhooks.
npm create ovok@latest my-app
npm install --global @ovok/cliStart building
Create an app with create-ovok
Start a Turborepo with an Ovok web app and mobile app in one command.
Sign in
Save a client application as the profile the other commands use.
Forward events to your machine
Receive FHIR and Signals events on localhost while you develop.
Listen for events
Forward FHIR and Signals events to your machine while you develop.
Manage Signals webhooks
List, create, test and rotate the webhooks Signals posts to.
Install the ovok command
npm install --global @ovok/cli
ovok --versionovok needs Node.js 22.12 or later. In a terminal, each command tells you when a newer version is
on npm.
Sign in
ovok acts as a client application of your project. Create one in the Ovok Console and keep its
ID and secret at hand. Then pipe the secret in, so it stays out of your shell history:
printf %s "$OVOK_CLIENT_SECRET" | ovok login --client-id {{CLIENT_ID}} --client-secret-stdinovok loginsigns in tohttps://api.sandbox.ovok.comunless you pass--base-url.- It saves a profile in
~/.config/ovok/profiles.json, readable by you only. - Keep more than one with
--profile <name>. Every command takes--profile. - In CI, set
OVOK_BASE_URL,OVOK_CLIENT_IDandOVOK_CLIENT_SECRETinstead. All three together take the place of a saved profile.
Signals routes, used by ovok webhooks and ovok listen --signals-url, need a manager app. FHIR
Subscriptions need an app whose access policy can create one. See
Signals access policies.
Get help in the terminal
Run ovok --help for the list of commands. Run ovok <command> --help for a command's options and
examples.
Reference
Last updated on