Skip to content
/ getmac Public
forked from bevry/getmac

Get the mac address of the current machine you are on via Node.js

License

Notifications You must be signed in to change notification settings

Jlomaka/getmac

 
 

Repository files navigation

getmac

Travis CI Build Status NPM version NPM downloads Dependency Status Dev Dependency Status
Patreon donate button Open Collective donate button Gratipay donate button Flattr donate button PayPal donate button Bitcoin donate button Wishlist browse button
Slack community badge

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

Install

NPM

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

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 Source + CoffeeScript + Require
  • getmac/esnext/index.js is CoffeeScript Compiled + ESNext + Require
  • getmac/es2015/index.js is CoffeeScript Compiled + ES2015 + Require

Older environments may need Babel's Polyfill or something similar.

Usage

CLI

  1. Install Globally: install -g getmac
  2. Run with: getmac-node

API

// 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

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

Contribute

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

Backers

Maintainers

These amazing people are maintaining this project:

Sponsors

No sponsors yet! Will you be the first?

Patreon donate button Open Collective donate button Gratipay donate button Flattr donate button PayPal donate button Bitcoin donate button Wishlist browse button

Contributors

These amazing people have contributed code to this project:

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

License

Unless stated otherwise all works are:

and licensed under:

About

Get the mac address of the current machine you are on via Node.js

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • CoffeeScript 95.3%
  • JavaScript 4.7%