This repository has been archived on 2020-01-20. You can view files and clone it, but cannot push or open issues or pull requests.
Go to file
Trent Mick 99679fff2a warning about this being experimental 2015-07-25 22:47:46 -07:00
bin rename to 'sdc' 2014-02-12 12:22:08 -08:00
deps first commit 2014-02-07 13:21:24 -08:00
docs first commit 2014-02-07 13:21:24 -08:00
etc unfinished and broken work :) 2015-07-25 22:47:45 -07:00
examples joyentcloud.com is deprecated, use joyent.com. 2015-05-18 14:07:45 -07:00
lib unfinished and broken work :) 2015-07-25 22:47:45 -07:00
tools rename to 'sdc' 2014-02-12 12:22:08 -08:00
.gitignore first commit 2014-02-07 13:21:24 -08:00
.gitmodules first commit 2014-02-07 13:21:24 -08:00
CHANGES.md rename to 'sdc' 2014-02-12 12:22:08 -08:00
Makefile rename to 'sdc' 2014-02-12 12:22:08 -08:00
README.md warning about this being experimental 2015-07-25 22:47:46 -07:00
TODO.md unfinished and broken work :) 2015-07-25 22:47:45 -07:00
package.json switch over to cloudapi2 (drop node-smartdc piggybacking); prefer 'user' to 'account' in APIs (a la node-manta) 2014-02-19 19:52:58 -08:00

README.md

sdc is a CLI for Joyent SmartDataCenter and the Joyent Public Cloud (https://my.joyent.com, http://www.joyent.com/products/compute-service).

This project is experimental and probably broken. For now, please look at node-smartdc.

Installation

  1. Install node.js.
  2. npm install -g sdc

Verify that installed and is on your PATH:

$ sdc --version
sdc CLI 1.0.0

Before you can used the CLI you'll need a Joyent account, an SSH key uploaded and sdc configured with those account details.

Setup

TODO

Getting Started

TODO

node-sdc differences with node-smartdc

  • There is a single sdc command instead of a number of sdc-FOO commands.
  • The SDC_USER envvar is accepted in preference to SDC_ACCOUNT.

cloudapi2.js differences with node-smartdc/lib/cloudapi.js

The old node-smartdc module included an lib for talking directly to the SDC Cloud API (node-smartdc/lib/cloudapi.js). Part of this module (node-sdc) is a re-write of the Cloud API lib with some backward incompatibilities. The differences and backward incompatibilities are discussed here.

  • Currently no caching options in cloudapi2.js (this should be re-added in some form). The noCache option to many of the cloudapi.js methods will not be re-added, it was a wart.
  • The leading account option to each cloudapi.js method has been dropped. It was redundant for the constructor account option.
  • "account" is now "user" in the CloudAPI constructor.
  • All (all? at least at the time of this writing) methods in cloudapi2.js have a signature of function (options, callback) instead of the sometimes haphazard extra arguments.