node package manager

dot-json

dot-json

Build Status

Easily edit a json file from the CLI or NodeJS.

Install global

npm install -g dot-json

or local

npm install --save dot-json

Use from the CLI

dot-json myfile.json user.name "John Doe"
dot-json myfile.json user.email "john@example.com"

myfile.json now looks like

{
    "user": {
        "name": "John Doe",
        "email": "john@example.com"
    }
}
dot-json myfile.json user.name
John Doe
Usage:
  dot-json <file> <key-path>             Get a value from a json file by key-path
  dot-json <file> <key-path> <value>     Assign a value at a key-path
  dot-json <file> <key-path> --delete    Delete a key by key-path
 
Options:
  -d --delete     Delete the key-path
  -h --help       Show this message with options
  -v --version    Print the version number

Quick tip for editing package.json

Add to .bash_profile:

alias package="dot-json package.json"

Use it like this:

package name "my-package"

Use it in NodeJS

Initialization

var DotJson = require('dot_json');
var myfile = new DotJson('myfile.json');

Writing

asynchronous

myfile.set('user.name', 'John Doe').set('user.email', 'john@example.com').save(function(){
  console.log('saved');
});

synchronous

myfile.set('user.name', 'John Doe').set('user.email', 'john@example.com').save();

myfile.json now looks like

{
    "user": {
        "name": "John Doe",
        "email": "john@example.com"
    }
}

Reading

asynchronous

myfile.get('user.name', function(value){
  // value = 'John Doe' 
  console.log(value);
});

synchronous

var value = myfile.get('user.name');
// value = 'John Doe' 
console.log(value);

Deleting

asynchronous

myfile.delete('user.name').save(function(){
  console.log('saved');
});

synchronous

myfile.delete('user.name').save();

myfile.json now looks like

{
    "user": {
        "email": "john@example.com"
    }
}

npmjs.org/package/dot-json

We ♥ your boss

Selectively mirror the npm registry inside your firewall. Filter packages based on security, licensing, code quality and more. Build awesome stuff faster. Try npm Enterprise for free…

how? learn more

Collaborators list

Stats

Try it out

Keywords

json, edit, get, set, delete, cli

Dependencies (2)

docopt, underscore-keypath

Dependents (4)

styled-components-ui-library, require-install, discogs-basics, and more