scalar project
Manage Scalar Docs projects.
| Command | Description |
|---|---|
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 deployments get |
Inspect an existing build in the selected team without resubmitting |
scalar project upgrade |
Upgrade a Scalar Docs configuration |
list
List projects and their slugs for the current team.
scalar project list [options]
Options
| Option | Description |
|---|---|
--json |
Print project details as JSON. |
--no-input |
Disable prompts and browser launches. |
get
Show project details for the current team.
scalar project get [options] <slug>
Arguments
| Argument | Description |
|---|---|
slug |
Required. Project slug from scalar project list. |
Options
| Option | Description |
|---|---|
--json |
Print project details as JSON. |
--no-input |
Disable prompts and browser launches. |
init
Initialize a local Scalar Docs project.
scalar project init [options]
Options
| Option | Description |
|---|---|
--json |
Output the result as JSON without prompting. |
-s, --subdomain [url] |
Subdomain for the published documentation. |
--force |
Overwrite existing configuration. |
--no-input |
Disable prompts and browser launches. |
check-config
Validate a Scalar configuration file.
scalar project check-config [options] [file]
Arguments
| Argument | Description |
|---|---|
file |
Scalar configuration file path (discovered in the current directory if omitted). |
Options
| Option | Description |
|---|---|
--no-input |
Disable prompts and browser launches. |
create
Create a Scalar project without a linked GitHub repository.
scalar project create [options]
Options
| Option | Description |
|---|---|
--json |
Output the result as JSON without prompting. |
-n, --name <name> |
Project name. |
-s, --slug <slug> |
Project slug. |
--no-input |
Disable prompts and browser launches. |
preview
Preview a Scalar Docs project locally.
scalar project preview [options] [config]
Arguments
| Argument | Description |
|---|---|
config |
Path to the Scalar configuration file (usually scalar.config.json5 or scalar.config.json). |
Options
| Option | Description | Default |
|---|---|---|
-p, --port [port] |
Preferred server port (uses another port if unavailable). | 7970 |
-H, --host [host] |
Host address for the preview server. | |
-L, --log-level <level> |
Set the log level. One of debug, info. |
info |
-N, --no-open |
Do not open the browser automatically. | |
--no-input |
Disable prompts and browser launches. |
publish
Publish a new build of a Scalar project.
scalar project publish [options]
Options
| Option | Description |
|---|---|
--json |
Output the result as JSON without prompting. |
-s, --slug [slug] |
Project slug from scalar project list. |
-c, --config [config] |
Scalar configuration file path for local publishing. |
-p, --preview |
Publish a preview without replacing the live deployment. |
-g, --github |
Publish from the linked GitHub repository instead of local files. |
--no-wait |
Return after acceptance without waiting for deployment. |
--timeout <seconds> |
Maximum deployment wait in seconds (default: 600; cannot combine with --no-wait). |
--no-input |
Disable prompts and browser launches. |
rollback
Roll the live deployment back to a previously deployed build.
scalar project rollback [options]
Options
| Option | Description |
|---|---|
--json |
Output the result as JSON without prompting. |
-s, --slug [slug] |
Project slug from scalar project list. |
-t, --to <publishUid> |
Roll back to a specific build id (defaults to the next older deployed build). |
-y, --yes |
Skip the confirmation prompt. |
--no-input |
Disable prompts and browser launches. |
deployments list
List production deployments for a project.
scalar project deployments list [options]
Options
| Option | Description |
|---|---|
--json |
Output the result as JSON without prompting. |
-s, --slug [slug] |
Project slug from scalar project list. |
--no-input |
Disable prompts and browser launches. |
deployments get
Inspect an existing build in the selected team without resubmitting.
scalar project deployments get [options] <build-id>
Arguments
| Argument | Description |
|---|---|
build-id |
Required. Accepted build ID, including preview builds. |
Options
| Option | Description |
|---|---|
--wait |
Wait for deployment instead of inspecting once. |
--timeout <seconds> |
Maximum status wait in seconds (default: 30, or 600 with --wait). |
--no-input |
Disable prompts and browser launches. |
upgrade
Upgrade a Scalar Docs configuration.
scalar project upgrade [options] [config]
Arguments
| Argument | Description |
|---|---|
config |
Path to the Scalar configuration file (usually scalar.config.json5 or scalar.config.json). |
Options
| Option | Description |
|---|---|
--json |
Output the result as JSON without prompting. |
--no-input |
Disable prompts and browser launches. |
What did you think of this content?
