Commands

Every command in @scalar/cli 2.11.0. Run scalar <command> --help for the same details in your terminal, or scalar context to get the whole tree as JSON for an AI agent.

scalar document

Work with OpenAPI and AsyncAPI descriptions.

• scalar document bundle: Bundle external references into a single API description
• scalar document split: Split an OpenAPI or AsyncAPI description into referenced JSON files
• scalar document join: Join API descriptions of the same format into one description
• scalar document format: Format an OpenAPI or AsyncAPI description
• scalar document convert: Convert a Postman collection to an OpenAPI description
• scalar document markdown: Generate Markdown documentation from an OpenAPI description
• scalar document mock: Run a Mock Server for OpenAPI operations or AsyncAPI WebSocket and SSE channels
• scalar document serve: Serve API Reference documentation from an OpenAPI or AsyncAPI description
• scalar document share: Publish an OpenAPI or AsyncAPI description to a public sandbox
• scalar document validate: Validate an OpenAPI or AsyncAPI description
• scalar document void: Mirror HTTP requests with a local server
• scalar document lint: Lint an OpenAPI or AsyncAPI description with Spectral rules
• scalar document upgrade: Upgrade an API description to OpenAPI 3.1 or the latest supported AsyncAPI version

scalar project

Manage Scalar Docs projects.

• scalar project list: List projects and their slugs for the current team
• scalar project get: Show project details for the current team
• scalar project init: Initialize a local Scalar Docs project
• scalar project check-config: Validate a Scalar configuration file
• scalar project create: Create a Scalar project without a linked GitHub repository
• scalar project preview: Preview a Scalar Docs project locally
• scalar project publish: Publish a new build of a Scalar project
• scalar project rollback: Roll the live deployment back to a previously deployed build
• scalar project deployments list: List production deployments for a project
• scalar project upgrade: Upgrade a Scalar Docs configuration

scalar registry

Manage API descriptions in the Scalar Registry.

• scalar registry publish: Publish an OpenAPI description to the Scalar Registry
• scalar registry update: Update API description metadata in the Scalar Registry
• scalar registry delete: Delete an API description from the Scalar Registry
• scalar registry list: List Scalar Registry API descriptions in a team namespace
• scalar registry get: Download an API description version from the Scalar Registry

scalar auth

Log in to Scalar and manage your session.

• scalar auth login: Log in to Scalar
• scalar auth whoami: Show the logged-in user and current team
• scalar auth logout: Log out of Scalar

scalar team

List and switch between your Scalar teams.

• scalar team list: List your Scalar teams
• scalar team get: Show the current team and its namespaces
• scalar team set: Select the current team

scalar schema

Manage shared schemas in the Scalar Registry.

• scalar schema delete: Delete a shared schema
• scalar schema update: Update shared schema metadata
• scalar schema list: List shared schemas in a team namespace
• scalar schema get: Download a shared schema version from the Scalar Registry
• scalar schema publish: Publish a shared schema to the Scalar Registry

scalar sdk

Manage Scalar SDKs (Enterprise only).

• scalar sdk list: List SDKs in a team namespace
• scalar sdk get: Inspect SDK metadata, API source, versions, and build status
• scalar sdk create: Create an SDK in the namespace of its source API
• scalar sdk update: Update SDK metadata
• scalar sdk delete: Delete an SDK
• scalar sdk build: Start an SDK build

scalar access-group

Manage access groups and allowed email domains for the current team.

• scalar access-group list: List access groups for the current team
• scalar access-group create: Create an access group (Pro or above)
• scalar access-group get: Get an access group and its allowlists
• scalar access-group update: Update access group metadata
• scalar access-group delete: Delete an access group and remove its project assignments
• scalar access-group domain add: Add an exact email domain to an access group
• scalar access-group domain remove: Remove an exact email domain from an access group

General

Commands for the CLI itself: help, upgrades, shell completion, and agent context.

• scalar readme: Open CLI documentation in your browser
• scalar readme generate: Generate the CLI README from the command tree
• scalar upgrade: Upgrade the Scalar CLI to the latest version
• scalar context: Print every command, argument, and option as JSON for AI agents
• scalar completion: Generate shell completion definitions