Menu Sheet Overlay
Search Sheet

Mobify CLI Tool Reference (Early Access)

    IMPORTANT! This feature is in progress and subject to changes.


    Mobify CLI is a command line interface with which you can manage your projects, targets, bundles, etc. on The Mobify CLI comes with the module progressive-web-sdk.

    Prerequisites to Run the Commands

    To use the Mobify CLI, you will need a developer account on Mobify Cloud. To request a developer account, contact Mobify Cloud support.

    Before you can use the Mobify CLI, you need to have a .mobify file in your home directory that contains your Mobify Cloud credentials. If you don’t have that, follow the steps in Saving Your Credentials

    How to Run the Commands

    After you install the progressive-web-sdk, you can add "mobify": "mobify" to the scripts object of the package.json file in the root folder of your project, then run the command by typing

    npm run mobify -- <command> <subcommand> [options]

    The -- is required, otherwise, the commands won’t run correctly.

    Help Docs

    If you have questions when you use the CLI, you can use the help docs.

    npm run mobify -- -h would show you a list of commands the CLI currently have.

    npm run mobify -- <command> -h will show you a list of sumcommands for that command.

    npm run mobify -- <command> <subcommand> -h will show you how to use a specific subcommand.