https://github.com/heapwolf/cdir

An interactive console.dir() for node.js similar to console.dir() in webkit.
https://github.com/heapwolf/cdir

Last synced: about 16 hours ago
JSON representation

An interactive console.dir() for node.js similar to console.dir() in webkit.

• Host: GitHub
• URL: https://github.com/heapwolf/cdir
• Owner: heapwolf
• Created: 2012-04-20T06:19:27.000Z (about 12 years ago)
• Default Branch: master
• Last Pushed: 2016-04-01T23:38:04.000Z (about 8 years ago)
• Last Synced: 2024-06-12T17:04:55.055Z (10 days ago)
• Language: JavaScript
• Homepage:
• Size: 183 KB
• Stars: 269
• Watchers: 9
• Forks: 18
• Open Issues: 7
• Metadata Files:
  • Readme: README.md

Lists

• awesome-stars - cdir - An interactive console.dir() for node.js similar to console.dir() in webkit. (JavaScript)

README

        
# Synopsis

An interactive representation of an object for the CLI similar to that of console.dir() in webkit.

# Motivation

Reading big object dumps is a waste of time. Progressive disclosure helps.

# Features

 - Searchable/Repeat search

 - Handles cyclical references

 - Expand and collapse nodes

# Usage

## Install

Do `npm install cdir -g` and then require the module in your program like this `console.dir = require('cdir')`.

## Navigate

Use `console.dir(someobject)` somewhere in your program and then hit `tab`, `shift+tab` or the arrow keys to cycle through the object's members. You can hit `space`, `return` or `enter` to expand a member.

## Search

Search by pressing the `/` key. This will display a `/` prompt. If you have already searched for something it will be displayed before the `/` prompt. For instance if you searched for "foobar" it would appear as `(foobar) /`.

## Quit

Hit `ctrl+c` or `q` to quit!

## Simple Example

There is a CLI version too if you want to use it. `npm install cdir -g`.

```js

console.dir = require('cdir');

var stuff = { 

  "name" : "cdir", 

  "description" : "An interactive console.dir() for the terminal.",

  "tags" : [

    "console",

    "debug",

    "debugging",

    "json",

    "interacive",

    "prompt"

  ],

  "foo": function() { 

    return "node tests/test.js"

  }

};

console.dir(stuff);

```

The output looks something like this.