Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bevry/getmac
Get the mac address of the current machine you are on via Node.js
https://github.com/bevry/getmac
executable mac-address nodejs
Last synced: 2 days ago
JSON representation
Get the mac address of the current machine you are on via Node.js
- Host: GitHub
- URL: https://github.com/bevry/getmac
- Owner: bevry
- License: other
- Created: 2013-02-12T06:08:48.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2024-10-12T16:36:41.000Z (4 months ago)
- Last Synced: 2024-10-30T00:55:55.885Z (3 months ago)
- Topics: executable, mac-address, nodejs
- Language: TypeScript
- Size: 753 KB
- Stars: 358
- Watchers: 10
- Forks: 54
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-nodejs-cn - getmac - 获取电脑的 MAC 地址 (包 / 网络)
- awesome-nodejs - getmac - Get the computer MAC address.  (Repository / Network)
- awesome-nodejs-cn - getmac - **star:358** 获取计算机MAC地址 (包 / 网络)
- awesome-nodejs - getmac - Get the computer MAC address. (Packages / Network)
- awesome-nodejs - getmac - Get the mac address of the current machine you are on via Node.js - ★ 160 (Network)
- awesome-node - getmac - Get the computer MAC address. (Packages / Network)
- awesome-nodejs-cn - getmac - 获取电脑的MAC地址. (目录 / 网络)
- awesome-nodejs - getmac - 获取或校验 MAC 地址 (Uncategorized / Uncategorized)
README
# 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.](http://master.getmac.bevry.surge.sh/docs/)
### CLI
Install globally `npm install -g getmac`, then run with `getmac-node`
### API
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')
}
```
### Advanced
If you want to do advanced filtering, use [`os.networkInterfaces()`](https://nodejs.org/dist/latest-v12.x/docs/api/os.html#os_os_networkinterfaces) instead.
## Install
### [npm](https://npmjs.com "npm is a package manager for javascript")
- Install: `npm install --save getmac`
- Import: `import pkg from ('getmac')`
- Require: `const pkg = require('getmac').default`
### [Deno](https://deno.land "Deno is a secure runtime for JavaScript and TypeScript, it is an alternative for Node.js")
``` typescript
import pkg from 'https://unpkg.com/getmac@^6.6.0/edition-deno/index.ts'
```
### [Editions](https://editions.bevry.me "Editions are the best way to produce and consume packages you care about.")
This package is published with the following editions:
- `getmac/source/index.ts` is [TypeScript](https://www.typescriptlang.org/ "TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.") source code with [Import](https://babeljs.io/docs/learn-es2015/#modules "ECMAScript Modules") for modules
- `getmac` aliases `getmac/edition-es2022/index.js`
- `getmac/edition-es2022/index.js` is [TypeScript](https://www.typescriptlang.org/ "TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.") compiled against [ES2022](https://en.wikipedia.org/wiki/ES2022 "ECMAScript 2022") for [Node.js](https://nodejs.org "Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine") 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21 with [Require](https://nodejs.org/dist/latest-v5.x/docs/api/modules.html "Node/CJS Modules") for modules
- `getmac/edition-es2022-esm/index.js` is [TypeScript](https://www.typescriptlang.org/ "TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.") compiled against [ES2022](https://en.wikipedia.org/wiki/ES2022 "ECMAScript 2022") for [Node.js](https://nodejs.org "Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine") 12 || 14 || 16 || 18 || 20 || 21 with [Import](https://babeljs.io/docs/learn-es2015/#modules "ECMAScript Modules") for modules
- `getmac/edition-types/index.d.ts` is [TypeScript](https://www.typescriptlang.org/ "TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.") compiled Types with [Import](https://babeljs.io/docs/learn-es2015/#modules "ECMAScript Modules") for modules
- `getmac/edition-deno/index.ts` is [TypeScript](https://www.typescriptlang.org/ "TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.") source code made to be compatible with [Deno](https://deno.land "Deno is a secure runtime for JavaScript and TypeScript, it is an alternative to Node.js")
## History
[Discover the release history by heading on over to the `HISTORY.md` file.](https://github.com/bevry/getmac/blob/HEAD/HISTORY.md#files)
## Backers
### Code
[Discover how to contribute via the `CONTRIBUTING.md` file.](https://github.com/bevry/getmac/blob/HEAD/CONTRIBUTING.md#files)
#### Authors
- [Benjamin Lupton](https://balupton.com) — Accelerating collaborative wisdom.
#### Maintainers
- [Benjamin Lupton](https://balupton.com) — Accelerating collaborative wisdom.
#### Contributors
- [Benjamin Lupton](https://github.com/balupton) — [view contributions](https://github.com/bevry/getmac/commits?author=balupton "View the GitHub contributions of Benjamin Lupton on repository bevry/getmac")
- [Benoit Sepe](https://github.com/benoitsepe) — [view contributions](https://github.com/bevry/getmac/commits?author=benoitsepe "View the GitHub contributions of Benoit Sepe on repository bevry/getmac")
- [Gustavo Costa Neves](https://github.com/guhcostan) — [view contributions](https://github.com/bevry/getmac/commits?author=guhcostan "View the GitHub contributions of Gustavo Costa Neves on repository bevry/getmac")
- [Isaac Huang](https://github.com/caasi) — [view contributions](https://github.com/bevry/getmac/commits?author=caasi "View the GitHub contributions of Isaac Huang on repository bevry/getmac")
- [Jan Pilzer](https://github.com/Hirse) — [view contributions](https://github.com/bevry/getmac/commits?author=Hirse "View the GitHub contributions of Jan Pilzer on repository bevry/getmac")
- [Stephen Brown II](https://github.com/StephenBrown2) — [view contributions](https://github.com/bevry/getmac/commits?author=StephenBrown2 "View the GitHub contributions of Stephen Brown II on repository bevry/getmac")
- [ted shroyer](https://github.com/tedshroyer) — [view contributions](https://github.com/bevry/getmac/commits?author=tedshroyer "View the GitHub contributions of ted shroyer on repository bevry/getmac")
- [zboszor](https://github.com/zboszor) — [view contributions](https://github.com/bevry/getmac/commits?author=zboszor "View the GitHub contributions of zboszor on repository bevry/getmac")
### Finances
#### Sponsors
- [Andrew Nesbitt](https://nesbitt.io) — Software engineer and researcher
- [Balsa](https://balsa.com) — We're Balsa, and we're building tools for builders.
- [Codecov](https://codecov.io) — Empower developers with tools to improve code quality and testing.
- [Poonacha Medappa](https://poonachamedappa.com)
- [Rob Morris](https://github.com/Rob-Morris)
- [Sentry](https://sentry.io) — Real-time crash reporting for your web apps, mobile apps, and games.
- [Syntax](https://syntax.fm) — Syntax Podcast
#### Donors
- [Andrew Nesbitt](https://nesbitt.io)
- [Armen Mkrtchian](https://mogoni.dev)
- [Balsa](https://balsa.com)
- [Chad](https://opencollective.com/chad8)
- [Codecov](https://codecov.io)
- [dr.dimitru](https://veliovgroup.com)
- [Elliott Ditman](https://elliottditman.com)
- [entroniq](https://gitlab.com/entroniq)
- [GitHub](https://github.com/about)
- [Hunter Beast](https://cryptoquick.com)
- [Jean-Luc Geering](https://github.com/jlgeering)
- [Michael Duane Mooring](https://mdm.cc)
- [Michael Harry Scepaniak](https://michaelscepaniak.com)
- [Mohammed Shah](https://github.com/smashah)
- [Mr. Henry](https://mrhenry.be)
- [Nermal](https://arjunaditya.vercel.app)
- [Pleo](https://pleo.io)
- [Poonacha Medappa](https://poonachamedappa.com)
- [Rob Morris](https://github.com/Rob-Morris)
- [Robert de Forest](https://github.com/rdeforest)
- [Sentry](https://sentry.io)
- [ServieJS](https://github.com/serviejs)
- [Skunk Team](https://skunk.team)
- [Syntax](https://syntax.fm)
- [WriterJohnBuck](https://github.com/WriterJohnBuck)
## License
Unless stated otherwise all works are:
- Copyright © [Benjamin Lupton](https://balupton.com)
and licensed under:
- [Artistic License 2.0](http://spdx.org/licenses/Artistic-2.0.html)