Forio CLI

Forio CLI is both a set of tools to ease your workflow for working with simulations on Forio Epicenter or Forio Simulate, as well as a framework for making your own.

Note when syncing with Forio Epicenter

The folder containing your interface files must be named "static" as this folder is synced directly with the Epicenter "static" (interface) folder.

Quick Start - Mac/Linux

$ npm install -g coffee-script #If you don't already have it
$ git clone https://github.com/forio/forio-cli.git
$ cd forio-cli
$ npm install
$ chmod +x index.coffee
$ cp config-sample.json config.json #Use this to manage creds until SIMULATE-6036 is fixed

Edit the file "config.json" in the "forio-cli" directory. cd into your project directory, one level up from "static" folder containing the source. Finally, run the script.

$ alias F='~/PROJECT_PATH/forio-cli/index.coffee'
$ F sync static:<TEAM_NAME>/<PROJECT_NAME>

Quick Start - Windows

For Windows, the usage is a little different as Windows does not support aliases or chmod. In the line below, change the paths for the forio-cli directory as appropriate.

$ npm install -g coffee-script #If you don't already have it
$ git clone https://github.com/forio/forio-cli.git
$ cd forio-cli
$ npm install

Create a file "config.json" based on "config-sample.json" in the "forio-cli" directory. Then cd into your project directory, one level up from "static" folder containing the source. Finally, run the script.

$ coffee <PATH_TO_FORIO_CLI>\forio-cli\index.coffee sync static:<TEAM_NAME>/<PROJECT_NAME>

Commands

Commands are high-level actions you're allowed to perform. Each command can define its own optional parameters. Invoking the command without specifying any of the required options prints out the usage. The following commands are currently supported

Usage: F <command>

command     one of: deploy, sync

F deploy

Usage: F deploy <mapping> [options]

mapping     <local_dir>:<account>/<project>

Options:
   -p, --platform      Platform (epicenter or simulate)  [epicenter]
   -c, --config_file   Path to config file  [./config.json]
   -d, --domain        Domain Epicenter or Simulate is hosted on  [api.forio.com or forio.com]

Deploy files to a simulation

This will ask for a confirmation before deploying, and also make sure the path you're deploying to exists.

Skipping local_dir in the mapping defaults to current working directory. Skipping account defaults to using your account.

F sync

Usage: F sync <mapping> [options]

mapping     <local_dir>:<account>/<project>

Options:
   -p, --platform      Platform (epicenter or simulate)  [epicenter]
   -c, --config_file   Path to config file  [./config.json]
   -d, --domain        Domain Epicenter or Simulate is hosted on  [api.forio.com or forio.com]
   -i, --ignore        Regex with pattern of files to ignore for sync

Watch dir for changes and upload to a simulation

Skipping local_dir in the mapping defaults to current working directory. Skipping account defaults to using your account.

This command may crash on OS X when uploading a large number of files simultaneously. This can be fixed by running this command in your terminal, or putting it in your ~/.bash_profile file:

ulimit -n 10000

Creating new commands

Creating new commands is fairly straight forward.

1. Create a new .coffee file under lib/runnable
2. Implement the command interface

All commands need to implement the following interface.

• exports.help: One line description of what the command does
• exports.options: An object with the options you want to expose. See nomnom for options.
• exports.run: This command will be passed a parsed object with any parameters passed from the console. Do with it what you will.

Other utilities

The "misc" directory contains utilities that could not be integrated with the F command. Right now, the only thing in it is makeSymlink.