getmac

Get the MAC address of the current machine you are on.

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.

Usage

Complete API Documentation.

$3

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

$3

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

``javascript
import getMAC, { isMAC } from 'getmac'

// Fetch the computer's MAC address
console.log(getMAC())

// Fetch the computer's MAC address for a specific interface
console.log(getMAC('eth0'))

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

$3

If you want to do advanced filtering, use os.networkInterfaces() instead.

Install

$3

- Install: npm install --save getmac
- Import: import pkg from ('getmac')
- Require: const pkg = require('getmac').default

$3

` typescript
import pkg from 'https://unpkg.com/getmac@^6.6.0/edition-deno/index.ts'
`


$3

This package is published with the following editions:
- getmac/source/index.ts is TypeScript source code with Import for modules
- getmac aliases getmac/edition-es2022/index.js
- getmac/edition-es2022/index.js is TypeScript compiled against ES2022 for Node.js 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21 with Require for modules
- getmac/edition-es2022-esm/index.js is TypeScript compiled against ES2022 for Node.js 12 || 14 || 16 || 18 || 20 || 21 with Import for modules
- getmac/edition-types/index.d.ts is TypeScript compiled Types with Import for modules
- getmac/edition-deno/index.ts is TypeScript source code made to be compatible with Deno

History

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

Backers

$3

Discover how to contribute via the CONTRIBUTING.md` file.

#### Authors

- Benjamin Lupton — Accelerating collaborative wisdom.

#### Maintainers

- Benjamin Lupton — Accelerating collaborative wisdom.

#### Contributors

- Benjamin Lupton — view contributions
- Benoit Sepe — view contributions
- Gustavo Costa Neves — view contributions
- Isaac Huang — view contributions
- Jan Pilzer — view contributions
- Stephen Brown II — view contributions
- ted shroyer — view contributions
- zboszor — view contributions

$3

#### Sponsors

- Andrew Nesbitt — Software engineer and researcher
- Balsa — We're Balsa, and we're building tools for builders.
- Codecov — Empower developers with tools to improve code quality and testing.
- Poonacha Medappa
- Rob Morris
- Sentry — Real-time crash reporting for your web apps, mobile apps, and games.
- Syntax — Syntax Podcast

#### Donors

- Andrew Nesbitt
- Armen Mkrtchian
- Balsa
- Chad
- Codecov
- dr.dimitru
- Elliott Ditman
- entroniq
- GitHub
- Hunter Beast
- Jean-Luc Geering
- Michael Duane Mooring
- Michael Harry Scepaniak
- Mohammed Shah
- Mr. Henry
- Nermal
- Pleo
- Poonacha Medappa
- Rob Morris
- Robert de Forest
- Sentry
- ServieJS
- Skunk Team
- Syntax
- WriterJohnBuck

License

Unless stated otherwise all works are:

- Copyright © Benjamin Lupton

and licensed under:

- Artistic License 2.0