<commit_before># Forio CLI

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

## Quick Start

    $ git clone https://github.com/forio/forio-cli.git
    $ npm install
    $ chmod +x index.coffee
    $ alias F='your/path/index.coffee'

## Commands
Commands are high-level actions you're allowed to perform. Each command can take it it's own optional parameters. Invoking the command without specifying any of the default options prints out the useage. The following commands are currently supported

    Usage: F <command>

    command     one of: deploy, sync

### Deploy

    Usage: F deploy <mapping> [options]

    mapping     <local_dir>:<sim_author>/<sim_name>

    Options:
       -c, --config_file   Path to config file  [~/../../config.json]

    Deploy files to a simulation

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

### Sync
    Usage: F sync <mapping> [options]

    mapping     <local_dir>:<sim_author>/<sim_name>

    Options:
       -c, --config_file   Path to config file  [/Users/narenranjit/FPrjs/scripts/lib/runnable/../../config.json]
       -i, --ignore        Regex with pattern of files to ignore for sync

    Watch dir for changes and upload to simulation

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


## 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.run*: An object with the options you want to expose. See [nomnom][nom_nom_site] for options.
    - *exports.help*: One line description of what the command does
    - *exports.run*: This command will be passed a parsed object with any parameters passed from the console. Do with it what you will.


[nom_nom_site]: https://github.com/harthur/nomnom
<commit_msg>readme typos<commit_after># Forio CLI

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

## Quick Start

    $ git clone https://github.com/forio/forio-cli.git && cd forio-cli
    $ npm install
    $ chmod +x index.coffee
    $ alias F='your/path/index.coffee'

## Commands
Commands are high-level actions you're allowed to perform. Each command can take it it's own optional parameters. Invoking the command without specifying any of the default options prints out the useage. The following commands are currently supported

    Usage: F <command>

    command     one of: deploy, sync

### Deploy

    Usage: F deploy <mapping> [options]

    mapping     <local_dir>:<sim_author>/<sim_name>

    Options:
       -c, --config_file   Path to config file  [~/../../config.json]

    Deploy files to a simulation

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

### Sync
    Usage: F sync <mapping> [options]

    mapping     <local_dir>:<sim_author>/<sim_name>

    Options:
       -c, --config_file   Path to config file  [/Users/narenranjit/FPrjs/scripts/lib/runnable/../../config.json]
       -i, --ignore        Regex with pattern of files to ignore for sync

    Watch dir for changes and upload to simulation

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


## 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.run__: An object with the options you want to expose. See [nomnom][nom_nom_site] for options.
- __exports.help__: One line description of what the command does
- __exports.run__: This command will be passed a parsed object with any parameters passed from the console. Do with it what you will.


[nom_nom_site]: https://github.com/harthur/nomnom

{'fraction_non_alphanumeric': 0.07697876447876448, 'fraction_numerical': 0.0009652509652509653, 'mean_word_length': 3.335774058577406, 'pattern_counts': {'":': 0, '<': 21, '<?xml version=': 0, '>': 21, 'https://': 4, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1935192', 'n_tokens_mistral': 1190, 'n_tokens_neox': 1127, 'n_words': 518}