Plasmic CLI Usage

The Plasmic CLI makes it easy to invoke code generation of Plasmic components as you develop your application.

Here are all the commands and options:

$ plasmic -h

Usage: plasmic <command> [options]

Commands:

index.js init Initializes Plasmic for a project.

index.js sync Syncs designs from Plasmic to local files.

index.js watch Watches for updates to projects, and syncs them

automatically to local files.

index.js fix-imports Fixes import paths after you've moved around Plasmic

blackbox files

Options:

--version Show version number [boolean]

--auth Plasmic auth file to use; by default, uses ~/.plasmic.auth, or the

first .plasmic.auth file found in current and parent directories

--config Plasmic config file to use; by default, uses the first

plasmic.json file found in the current or parent directories

-h, --help Show help [boolean]

plasmic init

This command will generate a plasmic.json file and .plasmic.auth (if one doesn’t already exist).

$ plasmic init -h

plasmic init

Initializes Plasmic for a project.

Options:

--version Show version number [boolean]

--auth Plasmic auth file to use; by default, uses ~/.plasmic.auth, or

the first .plasmic.auth file found in current and parent

directories

--config Plasmic config file to use; by default, uses the first

plasmic.json file found in the current or parent directories

-h, --help Show help [boolean]

--host Plasmic host to use

[string] [default: "https://studio.plasmic.app"]

--platform Target platform to generate code for

[choices: "react"] [default: "react"]

--code-lang Target language to generate code for

[choices: "", "js", "ts"] [default: ""]

--code-scheme Code generation scheme to use

[choices: "", "blackbox", "direct"] [default: ""]

--src-dir Default directory to put React component files (that you edit)

into [string] [default: ""]

--plasmic-dir Default directory to put Plasmic-managed files into; relative

​​plasmic init