Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/feross/hostile
Simple, programmatic `/etc/hosts` manipulation (in node.js)
https://github.com/feross/hostile
hosts ip javascript nodejs
Last synced: 18 days ago
JSON representation
Simple, programmatic `/etc/hosts` manipulation (in node.js)
- Host: GitHub
- URL: https://github.com/feross/hostile
- Owner: feross
- License: mit
- Created: 2013-07-18T01:51:02.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2024-07-23T16:47:46.000Z (3 months ago)
- Last Synced: 2024-09-07T19:27:50.108Z (about 2 months ago)
- Topics: hosts, ip, javascript, nodejs
- Language: JavaScript
- Homepage:
- Size: 94.7 KB
- Stars: 776
- Watchers: 15
- Forks: 51
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# hostile [![ci][ci-image]][ci-url] [![npm][npm-image]][npm-url] [![downloads][downloads-image]][downloads-url] [![javascript style guide][standard-image]][standard-url]
[ci-image]: https://img.shields.io/github/workflow/status/feross/hostile/ci/master
[ci-url]: https://github.com/feross/hostile/actions
[npm-image]: https://img.shields.io/npm/v/hostile.svg
[npm-url]: https://npmjs.org/package/hostile
[downloads-image]: https://img.shields.io/npm/dm/hostile.svg
[downloads-url]: https://npmjs.org/package/hostile
[standard-image]: https://img.shields.io/badge/code_style-standard-brightgreen.svg
[standard-url]: https://standardjs.com
#### Simple, programmatic `/etc/hosts` manipulation (in node.js)
## install
```bash
npm install hostile
```
## usage
If you use OS X or Linux, this module assumes your hosts file is at `/etc/hosts`. On
Windows, it assumes your hosts file is at `C:/Windows/System32/drivers/etc/hosts`.
**Commands that modify the hosts file require root privileges.**
#### list all host file records
```bash
hostile list
```
#### set a domain in the hosts file
```bash
hostile set [ip] [host]
```
examples:
```bash
hostile set localhost domain.com
hostile set 192.168.33.10 domain.com
```
#### remove a domain from the hosts file
```bash
hostile remove [host]
```
example:
```bash
hostile remove domain.com
```
#### load a set of hosts from a file
```bash
hostile load [file_path]
```
hosts.txt
```bash
# hosts.txt
127.0.0.1 github.com
127.0.0.1 twitter.com
```
example:
```bash
hostile load hosts.txt
```
#### unload [remove] a set of hosts from a file
```bash
hostile unload [file_path]
```
```bash
# hosts.txt
127.0.0.1 github.com
127.0.0.1 twitter.com
```
example:
```bash
hostile unload hosts.txt
```
## methods
Commands that modify the hosts file require root privileges.
I wouldn't recommend running your production node server with admin privileges unless you
downgrade to a normal user with
[`process.setuid(id)`](http://nodejs.org/api/process.html#process_process_setuid_id)
before you start accepting requests.
**All methods have sync versions. Just omit the callback parameter.**
#### add a rule to /etc/hosts
```js
var hostile = require('hostile')
hostile.set('127.0.0.1', 'peercdn.com', function (err) {
if (err) {
console.error(err)
} else {
console.log('set /etc/hosts successfully!')
}
})
```
If the rule already exists, then this does nothing.
#### remove a rule from /etc/hosts
```js
hostile.remove('127.0.0.1', 'peercdn.com', function (err) {
if (err) {
console.error(err)
} else {
console.log('set /etc/hosts successfully!')
}
})
```
If the rule does not exist, then this does nothing.
#### get all lines in /etc/hosts
```js
// If `preserveFormatting` is true, then include comments, blank lines and other
// non-host entries in the result
var preserveFormatting = false
hostile.get(preserveFormatting, function (err, lines) {
if (err) {
console.error(err.message)
}
lines.forEach(function (line) {
console.log(line) // [IP, Host]
})
})
```
#### get all lines in any file
```js
// If `preserveFormatting` is true, then include comments, blank lines and other
// non-host entries in the result
var preserveFormatting = false
hostile.getFile(file_path, preserveFormatting, function (err, lines) {
if (err) {
console.error(err.message)
}
lines.forEach(function (line) {
console.log(line) // [IP, Host]
})
})
```
## contributors
- [Feross Aboukhadijeh](http://feross.org) (author)
- [Maayan Glikser](https://github.com/morsdyce)
## license
MIT. Copyright (c) [Feross Aboukhadijeh](http://feross.org).