<commit_before>node-smartdc is a node.js client library and set of CLI tools for using with
the [Joyent SmartDataCenter API](http://apidocs.joyent.com/cloudapi/), for
example the [Joyent Compute
Service](http://www.joyent.com/products/compute-service).

(Note: Current releases and the #master branch of this are for SmartDataCenter
(SDC) version 7.  It is not 100% backward compatible with SDC 6.5. For 100%
compatility with SDC 6.5, you must install a "6.5.x" version of this module.)


# Installation

To use the CLI tools (a number of `sdc-*` commands) you may want to install
globally:

    npm install -g smartdc

The CLI commands typical work with JSON content. We suggest you also install
the [`json` tool](https://github.com/trentm/json) for working with JSON on the
command line. The examples below use `json` heavily.

    npm install -g jsontool   # *not* 'npm install json'


# CLI Setup and Authentication

There are CLI commands corresponding to almost every action available in the
SmartDataCenter API; see the [Joyent CloudAPI
documentation](http://apidocs.joyent.com/cloudapi/) for complete information.
Each command takes `--url`, `--account`, and `--keyId` flags to provide the
API endpoint URL and your credentials. However you'll probably want to set
the environment variable equivalents:

* `SDC_URL` (`--url | -u`): URL of the CloudAPI endpoint. E.g.
  "https://us-sw-1.api.joyentcloud.com".
* `SDC_ACCOUNT` (`--account | -a`): Login name/username. E.g. "bob".
* `SDC_KEY_ID` (`--keyId | -k`): The fingerprint of an SSH public key that has
  been added to the account set in `SDC_ACCOUNT`. This is used for signing
  requests. If you use an SSH agent, the fingerprint is shown in `ssh-add -l`
  output. You can calculate the fingerprint like this:<commit_msg>Fix jsontool reference in README.md Reviewed by: <NAME> <<EMAIL>><commit_after>node-smartdc is a node.js client library and set of CLI tools for using with
the [Joyent SmartDataCenter API](http://apidocs.joyent.com/cloudapi/), for
example the [Joyent Compute
Service](http://www.joyent.com/products/compute-service).

(Note: Current releases and the #master branch of this are for SmartDataCenter
(SDC) version 7.  It is not 100% backward compatible with SDC 6.5. For 100%
compatility with SDC 6.5, you must install a "6.5.x" version of this module.)


# Installation

To use the CLI tools (a number of `sdc-*` commands) you may want to install
globally:

    npm install -g smartdc

The CLI commands typical work with JSON content. We suggest you also install
the [`json` tool](https://github.com/trentm/json) for working with JSON on the
command line. The examples below use `json` heavily.

    npm install -g json


# CLI Setup and Authentication

There are CLI commands corresponding to almost every action available in the
SmartDataCenter API; see the [Joyent CloudAPI
documentation](http://apidocs.joyent.com/cloudapi/) for complete information.
Each command takes `--url`, `--account`, and `--keyId` flags to provide the
API endpoint URL and your credentials. However you'll probably want to set
the environment variable equivalents:

* `SDC_URL` (`--url | -u`): URL of the CloudAPI endpoint. E.g.
  "https://us-sw-1.api.joyentcloud.com".
* `SDC_ACCOUNT` (`--account | -a`): Login name/username. E.g. "bob".
* `SDC_KEY_ID` (`--keyId | -k`): The fingerprint of an SSH public key that has
  been added to the account set in `SDC_ACCOUNT`. This is used for signing
  requests. If you use an SSH agent, the fingerprint is shown in `ssh-add -l`
  output. You can calculate the fingerprint like this:
{'fraction_non_alphanumeric': 0.100697350069735, 'fraction_numerical': 0.007810320781032078, 'mean_word_length': 4.02945301542777, 'pattern_counts': {'":': 0, '<': 6, '<?xml version=': 0, '>': 6, 'https://': 4, 'lorem ipsum': 0, 'www.': 2, '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': '2030072', 'n_tokens_mistral': 1134, 'n_tokens_neox': 1048, 'n_words': 481}