This quick start is intended for intermediate to advanced users. For a gentler introduction to Plasmic, check out our tutorial.
You can either install the CLI globally:
yarn global add @plasmicapp/cli # or: npm install -g @plasmicapp/cli
or locally to your workspace:
yarn add -D @plasmicapp/cli # or: npm install --save-dev @plasmicapp/cli
You can get your PROJECTID from the URL of your project.
If you don’t have a project yet, get started quickly with one of our starter templates.
plasmic sync --projects PROJECTID # or: yarn plasmic sync --projects PROJECTID # or: npx plasmic sync --projects PROJECTID
Your components are synced to
src/ by default.
If this is your first time syncing, the CLI will prompt you to enter your credentials, initialize your
plasmic.json, and install our small runtime library (
Whenever you want to pull updated Plasmic components, you can simply run:
plasmic sync # or: yarn plasmic sync # or: npx plasmic sync
Check out our Developer Guide for more details.