chauncey

1.0.14 • Public • Published

chauncey

build status npm version npm downloads Dependency status devDependency Status

Shorten URLs with Bitly.

Usage: chauncey <url> [options]

Options:
  -h, --help  Show help

Example:
  chauncey http://google.com/  Shorten http://google.com/ using Bitly

"Chauncey"?

Chauncey McPufferson is Bitly's mascot 😃

Installation

$ npm i -g chauncey

Configuration

First you need a Bitly developer access token. You can either pass this token directly via the API, or add it to your user environment so chauncey can pick it up automatically. For example:

$ BITLY_ACCESS_TOKEN=123abc chauncey http://google.com/

You can also use a .chaunceyrc file. Chauncey will look for .chaunceyrc starting in process.cwd(), then ../, ../../, all the way up to the filesystem root. It should have the following content:

export BITLY_ACCESS_TOKEN=123abc

Usage

CLI

Chauncey will output the shortened URL to stdout:

$ chauncey http://google.com/
http://bit.ly/1jib0Hi

So on OS X, you can do stuff like:

$ chauncey http://google.com/ | pbcopy

API

chauncey(url, [token], [done])

Shortens url using the Bitly API.

Arguments

  • url - The URL to shorten.
  • token - Optional Bitly access token. Will take precedence over BITLY_ACCESS_TOKEN defined in the user environment (see configuration).
  • done(error, result) - Optional A callback which is called with the shortened URL, or an error.

Example

import chauncey from 'chauncey';
 
chauncey({
  url: 'http://google.com/',
  token: '123abc',
  done: (error, result) => {
    if (error) return console.error(error.message);
    console.log(result);
  }
});

Tests

$ npm test

Note

This module uses the Bitly API, but is neither developed nor endorsed by Bitly.

License

MIT

Package Sidebar

Install

npm i chauncey

Weekly Downloads

15

Version

1.0.14

License

MIT

Last publish

Collaborators

  • tanem