/mantra-cli

Command line interface for building Meteor apps with Mantra

Primary LanguageJavaScriptMIT LicenseMIT

Mantra CLI

Build Status

A command line interface for developing Meteor apps using Mantra.

Installation

npm install -g mantra-cli

Documentation

The available commands are:

Currently, CLI expects you to be in the app root directory.


mantra create [path]

alias: c

Create a Meteor application using Mantra spec under path.

It creates a Meteor app, prepares the directories and files, adds Meteor and NPM dependencies, and installs the NPM dependencies.


mantra generate [type] [name]

alias: g

Generate a file of type and name specified name.

type

Possible values are:

  • action
  • component

By default, a stateless component is generated. By using --use-class option (alias -c), you can generate a ES2015 class extending React.Component.

mantra g component core:user_list -c
  • container

Generates a container and its corresponding component.

  • collection

Use --schema option (alias -s) to specify the schema solution to use for your Mongo collections. Currently, you can specify collection2.

mantra g collection books -s collection2
  • method
  • publication
  • module

name

If the type is one of action, component, or container, the name should follow the format moduleName:entityName. This is because Mantra is modular on the client side, and all files of those types belong to a module.

Example

mantra generate component core:posts
mantra generate publication users
mantra generate method comments

Automatic update to index.js

For action, collection, method, and publication, the command automatically inserts import and export statements to the relevant index.js file.


mantra destroy [type] [name]

alias: d

Destroys all files that its counterpart mantra generate command would generate. You can provide all types supported by the generate command.

This command removes files.


Contributor Guide

  • Clone this repository and run npm install.
  • Write your code under /lib.
  • npm run-script compile compiles your ES2015 code in /lib into /dist.
  • npm test compiles the code and runs the tests.

License

MIT