oc

orion-cli

Console scaffolding and development tool for Meteor Apps

Showing:

Popularity

Downloads/wk

13

GitHub Stars

77

Maintenance

Last Commit

4yrs ago

Contributors

5

Package

Dependencies

6

License

Type Definitions

Tree-Shakeable

No?

Categories

Readme

orion-cli

Console scaffolding and development tool for Meteor Apps.

How to install

npm install -g orion-cli

How to use

Creating apps

You can create meteor apps by using orion create, which downloads the Meteor Boilerplate. --blank or -b let's you create a blank app (same as calling orion init).

orion create meteorApp
orion create -b blankApp

If you have a proxy, you need to set the http_proxy variable to access the repository.

export http_proxy=http://myproxy.net:myport

Reset apps

You can reset the app to remove all the default code.

orion reset

Initializing exiting apps

Initialize Meteor Apps for use with scaffolding with following command.

cd existingMeteorApp
orion init

The resulting file orion-config.json under private/ has existing templates, list them by calling orion generate. The configuration has following structure.

{
    "generate" : {
        "templateName" : {
            "default" : {
                "desc" : "description for template",
                "files" : ["private/templates/someFile.html"],
                "variables" : [
                    {
                        "name" : "templateVar",
                        "desc" : "templateQuestion"
                    }
                ]
            },
            "otherProfileName" : {
                "files" : ["private/templates/someOtherFile.html"]
            }
        }
    }
}

The template file also has one required line of configuration, which looks like following.

<!-- { "path" : "client/views/__templateVar__.html" } -->
<template name="__templateVar__">
    <h1>This is the content</h1>
<template>

You can use the variables in the template, as long as the json configuration for the path is on the first line it'll recognize it.

Generating files

You can create components, routes, models and more in the default configuration or change it and add more templates.

orion generate component
orion generate routes

Change profiles

The default profiles in the configuration are ES2015 and coffee, which generates other kind of files. You can also define your own profiles.

orion set-profile coffee

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100