0.0.3 • Published 8 years ago

sushi_cli v0.0.3

Weekly downloads
1
License
ISC
Repository
-
Last release
8 years ago

sushi_cli

This interface will allow you to use templates to create functional code from sushiroll.io's agnostic JSONs. You can:

  • write your own templates (or use ours),
  • use local JSONs (or use one created on our webapp),
  • specify the desired location of the output,
  • choose to initialize the folder with a .git,
  • ...and more coming soon

Getting started: Install the NPM package: npm install sushi_cli -g

Once installed, you can use the phrase sushi roll, with any of the following options:

Options:

  • -u, --url \<json_url> The -u flag allows you to add the URL to a JSON created through our webapp as the data for the template

  • -j, --json \<json_path> The -j flag allows you to add the path to locally stored JSON object to use as the data for the template

  • -t, --template \<template_path> The -t flag allows you to add the path to a locally stored template to use to output the proper files

  • -d, --directory \<directory_path> The -d flag allows you to specify the output location of the directory created by the template

  • -g, --git The -g flag will initialize a .git file in the directory

  • --sen The --sen flag indicates that you want to use the included Sequelize, Express, Node template

  • -r --ruby The -r flag indicates that you want to use the included Ruby on Rails template

Examples:

Super Basic:

  • I just used Sushi's webapp to create the agnostic JSON scaffolding for my database, it's accessible at: sushiroll.io/somelongurl.
  • I want to use the included Sequelize, Express, Node template to roll my sushi.
  • I want to create the file right in my working directory in the terminal. sushi roll --sen -u sushiroll.io/somelongurl

    Write Folder to Custom Location

  • sushi roll --sen -u sushiroll.io/somelongurl -d Users/nickrodriguez/newProjectFolder

    Use a Custom Template sushi roll -t Users/nickrodriguez/templates/directory containing your index.js -u sushiroll.io/somelongurl

    Use a Local JSON sushi roll -j Users/nickrodriguez/jsons/your JSON file -r