This package has been deprecated

Author message:

Resin-cli-auth is now built into Resin CLI itself, so this package is not maintained, and should not be used.

resin-cli-auth

resin-cli-auth

Join our online chat at

Resin.io CLI authentication handler.

This package is now deprecated

Resin-cli-auth is now built into Resin CLI itself, so this package is not maintained, and should not be used.

Role

The intention of this module is to provide a mechanism for the Resin CLI to automatically exchange the session token with the Resin.io web application.

THIS MODULE IS LOW LEVEL AND IS NOT MEANT TO BE USED BY END USERS DIRECTLY.

Unless you know what you're doing, use the Resin CLI instead.

Installation

Install resin-cli-auth by running:

$ npm install --save resin-cli-auth

Documentation

auth.login() ⇒ Promise

This function opens the user's default browser and points it to the Resin.io dashboard where the session token exchange will take place.

Once the the token is retrieved, it's automatically persisted.

Kind: static method of auth
Summary: Login to the Resin CLI using the web dashboard
Access: public
Fulfil: String - session token
Example

auth.login().then (sessionToken) ->
  console.log('I\'m logged in!')
  console.log("My session token is: #{sessionToken}")

Support

If you're having any problem, please raise an issue on GitHub and the Resin.io team will be happy to help.

Tests

Run the test suite by doing:

$ gulp test

Contribute

• Issue Tracker: github.com/resin-io/resin-cli-auth/issues
• Source Code: github.com/resin-io/resin-cli-auth

Before submitting a PR, please make sure that you include tests, and that coffeelint runs without any warning:

$ gulp lint

License

The project is licensed under the Apache 2.0 license.