scalar project
Manage scalar project. Generated from @scalar/cli 2.10.0.
| Command | Description |
|---|---|
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 |
list
List projects and their slugs for the current team.
scalar project list [options]
Options
| Option | Description |
|---|---|
--json |
Print project details as JSON. |
get
Get 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. |
init
Create a new Scalar Docs project.
scalar project init [options]
Options
| Option | Description |
|---|---|
-s, --subdomain [url] |
Subdomain to publish on. |
--force |
Override existing configuration. |
check-config
Check a Scalar Configuration file.
scalar project check-config [options] [file]
Arguments
| Argument | Description |
|---|---|
file |
File to check. |
create
Create a new project that is not linked to a github project.
scalar project create [options]
Options
| Option | Description |
|---|---|
-n, --name <name> |
Name of your project. |
-s, --slug <slug> |
Project slug. |
preview
Preview scalar guides.
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] |
Port to run the server on. If the port is not available, it will select another one. | 7970 |
-H, --host [host] |
Specify which IP addresses the server should listen on. | |
-L, --log-level <level> |
Set the log level. One of debug, info. |
info |
-N, --no-open |
Do not open the browser automatically. |
publish
Publish new build for a github sync project that is not linked.
scalar project publish [options]
Options
| Option | Description |
|---|---|
-s, --slug [slug] |
Project slug from scalar project list. |
-c, --config [config] |
Your config file of the project. |
-p, --preview |
Publish in preview mode. |
-g, --github |
Publish from your linked remote GitHub repository. |
rollback
Roll the live deployment back to a previously deployed build.
scalar project rollback [options]
Options
| Option | Description |
|---|---|
-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. |
deployments list
List the production deployment history for a project.
scalar project deployments list [options]
Options
| Option | Description |
|---|---|
-s, --slug [slug] |
Project slug from scalar project list. |
upgrade
Upgrade scalar project.
scalar project upgrade [options] [config]
Arguments
| Argument | Description |
|---|---|
config |
Path to the Scalar configuration file (usually scalar.config.json5 or scalar.config.json). |
