Commands

Every command in @scalar/cli 2.10.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

Manage local openapi file.

• scalar document bundle: Bundle an OpenAPI document by resolving all references and external dependencies
• scalar document split: Split OpenAPI or AsyncAPI documents into small chunks
• scalar document join: Merge multiple OpenAPI or AsyncAPI documents into a single unified document
• scalar document format: Format an OpenAPI or AsyncAPI file
• scalar document convert: Convert a Postman collection to an OpenAPI document
• scalar document markdown: Generate Markdown from an OpenAPI file
• scalar document mock: Mock an OpenAPI API or AsyncAPI WebSocket and SSE channels
• scalar document serve: Serve an API Reference from an OpenAPI or AsyncAPI file
• scalar document share: Share an OpenAPI or AsyncAPI file
• scalar document validate: Validate an OpenAPI or AsyncAPI file
• scalar document void: Boot a server to mirror HTTP requests
• scalar document lint: Lint your OpenAPI or AsyncAPI file using spectral rules
• scalar document upgrade: Upgrade an OpenAPI or AsyncAPI document to version 3.1

scalar project

Manage scalar project.

• scalar project list: List projects and their slugs for the current team
• scalar project get: Get project details for the current team
• scalar project init: Create a new Scalar Docs project
• scalar project check-config: Check a Scalar Configuration file
• scalar project create: Create a new project that is not linked to a github project
• scalar project preview: Preview scalar guides
• scalar project publish: Publish new build for a github sync project that is not linked
• scalar project rollback: Roll the live deployment back to a previously deployed build
• scalar project deployments list: List the production deployment history for a project
• scalar project upgrade: Upgrade scalar project

scalar registry

Manage your scalar registry.

• scalar registry publish: Publish an OpenAPI document to the Scalar registry
• scalar registry update: Update document metadata on scalar registry
• scalar registry delete: Delete a document from scalar registry
• scalar registry list: List all registry APIs for a team namespace
• scalar registry get: Get a document version from scalar registry

scalar auth

Manage authorization on scalar platform.

• scalar auth login: Login to scalar
• scalar auth whoami: Display the current user
• scalar auth logout: Logout from scalar

scalar team

Manage user teams.

• scalar team list: List all teams current user is part of
• scalar team get: Get the current team and its namespaces
• scalar team set: Set current active team for the user

scalar schema

Manage your Scalar schemas.

• scalar schema delete: Delete a schema
• scalar schema update: Update schema metadata
• scalar schema list: List all schemas for a team namespace
• scalar schema get: Get a schema document version from the Scalar registry
• scalar schema publish: Publish a shared schema to the Scalar registry

scalar sdk

Manage your Scalar SDKs (Enterprise Only).

• scalar sdk list: List all SDKs for a team namespace
• scalar sdk get: Inspect SDK metadata, API source, versions, and build status
• scalar sdk create: Create a new SDK. The SDK is created in the namespace of the API it is built from
• scalar sdk update: Update SDK metadata
• scalar sdk delete: Delete an SDK
• scalar sdk build: Build an SDK

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 documentation for the CLI
• scalar readme generate: Self generate documentation for the cli
• scalar upgrade: Upgrade current version of your cli
• scalar context: Print every command, argument, and option as JSON for AI agents
• scalar completion: Generate shell completion definitions