node package manager

preferences

Preferences

NPM version NPM downloads

Node.JS Module for handling encrypted user preferences.

Designed for CLI applications.

js-standard-style

Installation

npm install --save preferences

Usage

var Preferences = require("preferences");
 
// Init preference file with an unique identifier and an optional default data 
var prefs = new Preferences('com.your.app.identifier',{
  account: {
    username: 'MrRobot',
    password: 'fsociety'
  },
  test: {
    cycles: 1
  }
});
 
// Preferences can be accessed directly 
prefs.test.cycles++;
 
console.log(prefs.account);

Preferences are automatically saved on disk before process exit.

Encryption uses your private ssh key if founded, otherwise it will automatically use an identifier dependant generated password.

You can override the default key path in the options:

var prefs = new Preferences('com.foo.bar',{}, {
  key: '~/certs/my-custom-key.pem'
});

License

MIT. Copyright (c) 2015 Caffeina.

Manage permissions for the whole team

Manage developer teams with varying permissions and multiple projects. Learn more about Private Packages and Organizations…

how? learn more

Collaborators list

Stats

Try it out

Keywords

config, cli, preferences, encrypted, secure

Dependencies (4)

graceful-fs, mkdirp, os-homedir, write-file-atomic

Dependents (107)

cryptid, organizze, tnc, roof.js, whatsit-cli, images-grabber, omni-tools, inquirer-command-prompt, sphooks, @autolabjs/autolabcli, converse-cli, sleigh-cli, mailgun-extractor, gmail-cli, electron-linux-installer, onesaas-cli, create-repack-app, spice-traders-cli, mobileforms, mdx-cli, flash-generator, test-integration, heimctl, gcloud-switcher, mongoose-os, smartserve, pza-mercure-cli, domino-cli, @ecor/workspace, sam-generator, strike-cli, dsrepeater, rainbow-cli, command-line-app, bronos, 40banner, mongo-gen, meteordeployer, confluence-site, gintcli, webtest, itools-candidate-test, udemy-dl, crafty-cli, silicon-cli, fontchi-cli, proto-strike-cli, github-web, web-test, toolbeam-cli, and more