Skip to content

chameleoid/telepathy

Repository files navigation

NPM Downloads Builds Deps Coverage Receiving Progress

Telepathy

A sync-less "telepathic" password manager that generates repeatable site-specific passwords across any of your devices.

How does it work?

At the core, it uses HASH(secret + user + domain) -> base-convert(62/94)

Getting Started

Install with: npm install -g telepathy

> telepathy
Telepathically manage passwords.
Usage: telepathy
Version: 0.4.2

Options:
  -c, --config     config file                              [default: "/path/to/home/.telepathy.json"]
  -l, --length     password length                          [default: 10]
  -n, --count      number of passwords to display           [default: 1]
  -i, --index      starting password index                  [default: 0]
  -s, --safe       [deprecated] see lax                     [default: false]
  -x, --lax        lax mode (use base 62 instead of 94)     [default: false]
  -a, --algorithm  hashing algorithm to use                 [default: "SHA256"]
  -y, --clipboard  copy to clipboard instead of outputting  [default: true]
  -d, --domain                                              [required]
  -u, --username                                            [default: "you"]

> telepathy -d example.com
iIw+B2uWs,
u@FJ.K-s{:
(Eqo-9w.KV
f#2K@XEowy
0vU7ub/#&+

Examples

var Telepathy = require('telepathy');

console.log(new Telepathy('testing').password({
  user: 'rummik',
  domain: 'rummik.com',
  length: 300,
  alphabet: Telepathy.alphabet.base94,
}));

Contributing

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Please see the Chameleoid Styleguide before contributing.

Take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Gulp.

License

Copyright (c) 2012-2017 Chameleoid and Kimberly Zick (rummik)

Licensed under the MPL