CLI

This guide will help you interact with our registry with our CLI, programatically. If you want to also work with the registry with our cloud dashboard you can.

Generate TokenCopied!

If you choose to interface with our registry with our CLI or our API you will need to generate an API key this can be done in two steps

Go to https://dashboard.scalar.com and navigate to User > API Keys

Once you have your API key you can now use the CLI or API to interface with the registry.

Add an OpenAPI DocumentCopied!

Now let's add an OpenAPI document to the registry ✨

First you need to login, you can do that by the following two commands

scalar auth login

or

scalar auth login --token 1234secrettoken5678

Now you can interface with the registry by

scalar registry create ./openapi.yaml

Update an OpenAPI DocumentCopied!

Once you have an OpenAPI document on our registry, you can push up changes by a simple CLI call

scalar registry version scalar-galaxy ./openapi/galaxy.yaml --namespace scalar

Delete an OpenAPI DocumentCopied!

You can delete an OpenAPI document from the Registry > Overview page, however please consider the downstream effects of which products are depending on that OpenAPI document before deleting that resource.

scalar registry delete scalar-galaxy --namespace scalar