Package Exports

getmac

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (getmac) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

getmac

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.

Install

npm

Install Globally

Install: npm install --global getmac
Executable: getmac-node

Install Locally

Install: npm install --save getmac
Executable: npx getmac-node
Require: require('getmac')

Editions

This package is published with the following editions:

getmac/source/index.ts is typescript source code with import for modules
getmac aliases getmac/edition-node-12/index.js
getmac/edition-node-12/index.js is typescript compiled for node.js 12 with require for modules

Usage

API Documentation

CLI

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

API

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

import getMAC, { isMAC } from 'getmac'

// Fetch the computer's MAC address
getMAC(function(err, macAddress) {
    if (err) throw err
    console.log(macAddress)
})

// Fetch the computer's MAC address for a specific interace
getMAC('eth0', function(err, macAddress) {
    if (err) throw err
    console.log(macAddress)
})

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