Popularity
3.5
Growing
Activity
0.0
-
201
12
45

Monthly Downloads: 0
Programming language: CoffeeScript
License: MIT License
Tags: Network     Getmac     Ipconfig     Ifconfig     Mac-address     Mac    
Latest version: v1.4.6

getmac alternatives and similar modules

Based on the "Network" category

Do you think we are missing an alternative of getmac or a related project?

Add another 'Network' Module

README

<!-- TITLE/ -->

getmac

<!-- /TITLE -->

<!-- BADGES/ -->

<!-- /BADGES -->

<!-- DESCRIPTION/ -->

Get the mac address of the current machine you are on

<!-- /DESCRIPTION -->

Will run anywhere that the underlying commands are present:

  • On Windows, getmac is used

  • On Unix/Linux/Mac, ifconfig is used if present, otherwise ip is used

  • Other environments are not supported as they provide no way of fetching the mac address.

That means:

  • If you are building a server app, or a desktop app, and wanting to get the mac address of where the node.js process is run, then this will work as expected.

  • If you are building a server app, this will only get the mac address of the server. There is no way to get a web browser user's mac address without installing software on their computer.

  • If you are building an electron app, you can run this on the server-side then communicate it to the client side.

  • This library will not run in web browsers / on the client-side / in webpack / in browserify / in angular / in react / in jQuery / in HTML. It will only run on node.js environments, which the web browser is not.

<!-- INSTALL/ -->

Install

NPM Install: npm install --save getmac Executable: getmac-node Module: require('getmac')

Editions

This package is published with the following editions:

getmac aliases getmac/index.js which uses Editions to automatically select the correct edition for the consumers environment getmac/source/index.coffee is coffeescript source code with require for modules getmac/edition-esnext/index.js is coffeescript compiled for node.js with require for modules getmac/edition-node-0.10/index.js is coffeescript compiled for node.js >=0.10 with require for modules

<!-- /INSTALL -->

Usage

CLI

Install globally npm install -g getmac, then run with getmac-node

API

Install locally npm install --save getmac, then use like so:

// Fetch the computer's mac address
require('getmac').getMac(function(err, macAddress){
    if (err)  throw err
    console.log(macAddress)
})

// Fetch the computer's mac address for a specfici interace
require('getmac').getMac({iface: 'eth0'}, function(err, macAddress){
    if (err)  throw err
    console.log(macAddress)
})

// Validate that an address is a mac address
if ( require('getmac').isMac("e4:ce:8f:5b:a7:fc") ) {
    console.log('valid mac')
}
else {
    console.log('invalid mac')
}

<!-- HISTORY/ -->

History

Discover the release history by heading on over to the HISTORY.md file.

<!-- /HISTORY -->

<!-- CONTRIBUTE/ -->

Contribute

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

<!-- /CONTRIBUTE -->

<!-- BACKERS/ -->

Backers

Maintainers

These amazing people are maintaining this project:

Benjamin Lupton — view contributions

Sponsors

No sponsors yet! Will you be the first?

Contributors

These amazing people have contributed code to this project:

Benjamin Lupton — view contributions Stephen Brown II — view contributions ted shroyer — view contributions caasi Huang — view contributions zboszor — view contributions Gustavo Costa Neves — view contributions

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

<!-- /BACKERS -->

<!-- LICENSE/ -->

License

Unless stated otherwise all works are:

Copyright © 2013+ Bevry Pty Ltd

and licensed under:

MIT License

<!-- /LICENSE -->


*Note that all licence references and agreements mentioned in the getmac README section above are relevant to that project's source code only.