Frontify CLI
Prerequisite
Installation
npm install -g @frontify/frontify-cli
yarn global add @frontify/frontify-cli
Content Block
Create
npx @frontify/frontify-cli block create <app name>
The content block name needs to be lowercase, spaces are not allowed but you can use an underscore instead.
Example: my_custom_content_block
Serve
frontify-cli block serve
Params:
Parameters | Description | Type | Default Value |
---|
contentBlockPath | Directory of the block | string | Current dir |
entryPath | Path to the entry file | string | src/index.tsx |
settingsPath | Path to the settings file | string | src/settings.ts |
port | Port for the local web server | string | 5600 |
Deploy
frontify-cli block deploy --instance=<Frontify URL>
The Frontify URL represent your instance URL.
Example: weare.frontify.com
or https://weare.frontify.com
Authentification
Login
frontify-cli login --instance=<Frontify URL>
The Frontify URL represent your instance URL.
Example: weare.frontify.com
or https://weare.frontify.com
Logout
frontify-cli logout
Configuration
macOS: ~/Library/Preferences/frontify-cli-nodejs