apostrophe-cli

    2.3.7 • Public • Published

    Apostrophe CLI

    The Apostrophe CLI is a cross-platform starting point for creating and configuring ApostropheCMS projects, providing a simple boilerplate generator and wrapping other useful functions into an easy to use command line tool.

    Requires Node.js 8+

    First, install apostrophe-cli as a global NPM module:

    npm install -g apostrophe-cli

    To view the available commands in a given context, execute the newly-installed command with no arguments:

    apos

    Note: All Apostrophe CLI commands can also be run with apostrophe, the legacy command, in addition to apos.

    Create a project

    To create a new project with the tool:

    apos create-project <shortname-without-spaces>

    This will create a local copy of our standard Apostrophe Boilerplate.

    options

    Run create-project with a --boilerplate flag to start from a Github repository other than the standard apostrophe-boilerplate repo. For example, apos create-project <shortname-without-spaces> --boilerplate=https://github.com/apostrophecms/apostrophe-open-museum.git would create a project using the Open Museum demo.

    If you run the create-project command with the --setup flag, the command will also npm install the dependencies for the project and run apostrophe-users:add to create an admin user for the CMS, resulting in a fully bootstrapped project. This command will prompt you for a password for the admin user being created.

    Create a widget

    To bootstrap the necessary files and basic configuration for a new Apostrophe widget, run the following command from within your Apostrophe project's root directory:

    # "-widgets" will automatically be appended to the end of your module name
    apos create-widget fancy-button

    Note: You will then need to register this widget module in app.js so it is available in your project code. The same is true for the commands below when you create a piece module or generic module.

    // app.js
    module.exports = {
      // ...
      'fancy-button-widgets': {},
      // ...
    }

    Create a piece

    To bootstrap the necessary files and basic configuration for a new Apostrophe piece type, run the following command from within your Apostrophe project's root directory:

    # be sure to use the SINGULAR version of the name of your content type
    apos create-piece vegetable

    Then remember to register 'vegetables': {} in apps.js above.

    If you run the create-piece command with the --pages flag, the command will also set up a corresponding pieces-pages module with your new piece type. Similarly, you can run the create-piece command with the --widgets flag, which will also set up a corresponding pieces-widgets module along with your new piece type. These flags can be used together or separately.

    apos create-piece vegetable --pages --widgets

    Create an empty Apostrophe module

    To bootstrap the necessary files and basic configuration for a brand-new Apostrophe module that doesn't extend one of the usual suspects like pieces or widgets:

    apos create-module <module name>

    Remember to register the module in apps.js with the other module types.

    Run other Apostrophe-flavored command-line tasks

    To run an Apostrophe command-line task with the Apostrophe CLI, which are conventionally run like this: node app.js <namespace>:<task name>, you may instead execute the following from any location within a project's directory:

    apos <namespace>:<task name>

    The Apostrophe CLI assumes the apostrophe namespace when executing tasks. This means that if a task is in the apostrophe namespace (such as the apostrophe:generation task), you can simply execute:

    apos <task name>

    For more information on command-line tasks in Apostrophe, visit the Command line tasks documentation for Apostrophe.


    For more documentation for ApostropheCMS, visit the documentation site.

    Keywords

    none

    Install

    npm i apostrophe-cli

    DownloadsWeekly Downloads

    41

    Version

    2.3.7

    License

    MIT

    Unpacked Size

    21.6 kB

    Total Files

    12

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar