getmac v1.5.0-next.1573686306.dc1197af99c8afe969ed073f3a1f5c9a88ac4fe4

Get the mac address of the current machine you are on

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.

npm

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')
}

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

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

These amazing people are maintaining this project:

No sponsors yet! Will you be the first?

These amazing people have contributed code to this project:

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

Unless stated otherwise all works are:

and licensed under: