https://github.com/bahamas10/node-amass

Amass system information and expose it as JSON
https://github.com/bahamas10/node-amass

Last synced: about 2 months ago
JSON representation

Amass system information and expose it as JSON

• Host: GitHub
• URL: https://github.com/bahamas10/node-amass
• Owner: bahamas10
• Created: 2013-01-20T08:46:32.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2013-07-02T06:55:14.000Z (over 11 years ago)
• Last Synced: 2024-05-08T20:01:19.326Z (8 months ago)
• Language: JavaScript
• Size: 160 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
amass

=====

Amass system information and expose it as JSON

Installation

------------

    npm install -g amass

Usage

-----

![usage](http://instacode.linology.info/file/31969)

(hosted on http://instacode.linology.info/31969)

By default, amass exposes 3 keys

    amass | json -k

    [

      "amass",

      "os",

      "process"

    ]

You can extend this by writing [plugins](#plugins)

Why?

----

There are other well-known programs that do a similar function.  `amass` is written

completely in node, and as such, doesn't rely on user-land tools that often

behave differently on different operating systems, nor does it use and abuse

`sed`, `awk`, `cut`, etc. all information comes from node's builtin modules.

Also, speed.

    dave @ [ manilla :: (Darwin) ] ~/dev/node-amass $ time ./bin/amass.js > /dev/null

    real    0m0.064s

    user    0m0.053s

    sys     0m0.010s

Plugins

-------

### *still in beta*

Extend the functionality of `amass` by writing/using plugins

### how to add plugins

You may need to `sudo` some of these commands.

Adding a plugin ([amass-etc-passwd](https://github.com/bahamas10/amass-etc-passwd))

    $ amass --add amass-etc-passwd

    [email protected] node_modules/amass-etc-passwd

    └── [email protected] ([email protected])

Now, when you run `amass`, you'll see a new root key of `etc-passwd`

View the installed plugins

    $ amass --list

    [email protected] /private/var/amass

    └── [email protected]

That shows you the installed plugins and their dependencies.  If the output

looks familiar to you, it's because it is straight from `npm`.

Now, remove the plugin

    $ amass --remove amass-etc-passwd

    $ echo $?

    0

Notice no output is generated (just like `npm remove`), but that the exit code

is properly set.

List the plugins once more and see that it is empty

    $ amass --list

    [email protected] /private/var/amass

    └── (empty)

### write your own plugins

As of right now, a module must be published to npm before it can be used,

or symlinked to `/var/amass/node_modules`.  Let's create a simple hello world

plugin.

`/var/amass/node_modules/my_plugin/index.js`

``` js

module.exports = function(cb) {

    var data = {

        "name": "dave",

        "hello": "world"

    };

    cb(null, data);

};

```

There you go, that's it.  Now, when you run `amass`, you will see your data.

    $ amass | json my_plugin

    {

      "name": "dave",

      "hello": "world"

    }

To write a module, have your `exports` be a function that takes a single

argument (the callback), and call it with your data (or any error.

The key that the data will have in the `amass` output is the name of your

module.

### testing

You can test a module you are writing using `amass -t`

    amass -t 

### technical details

1. Plugins are stored in `/var/amass`, this directory is created lazily

when invoked with an option that pertains to plugins.

2. Plugins should be standalone node modules that expose useful system

information, and as such, be installed in node\_modules in `/var/amass`.

License

-------

MIT License