- Exciting news!Announcing our $4.6M Series Seed. Learn more →
@frontify/frontify-cli
Advanced tools
@frontify/frontify-cli
[](https://github.com/Frontify/frontify-cli/actions/workflows/continuous-integration.yml)
- 4.0.6latest
- Version published
- Maintainers
- 3
- Yearly downloads
- 5,184
Weekly downloads
Readme
Frontify CLI
Prerequisite
- Node >=14
Installation
npm install -g @frontify/frontify-cli
# Or
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
FAQs
What is @frontify/frontify-cli?
[](https://github.com/Frontify/frontify-cli/actions/workflows/continuous-integration.yml)
Is @frontify/frontify-cli popular?
The npm package @frontify/frontify-cli receives a total of 11 weekly downloads. As such, @frontify/frontify-cli popularity was classified as not popular.
Is @frontify/frontify-cli well maintained?
We found that @frontify/frontify-cli demonstrated a healthy version release cadence and project activity. It has 3 open source maintainers collaborating on the project.