mirror of https://github.com/octoleo/hosts.git synced 2024-05-30 05:00:48 +00:00

Go to file

William Melody cb9e20e554 Use capitalized form of $_ME variable. The capitalized version of this variable makes it easier to override, even though this is not technically part of the external API. There is no known downside of using the capitalized version of the variable.		2015-04-18 21:06:26 -07:00
hosts	Use capitalized form of $_ME variable.	2015-04-18 21:06:26 -07:00
LICENSE	Add license	2015-03-18 18:39:22 -07:00
Readme.md	Add ability to add an option comment when adding a record	2015-03-20 18:06:00 -07:00

Readme.md

Hosts

A command line program with shortcuts for managing hosts file entries.

Installation

To get started, add the hosts script to your path.

Homebrew

To install with homebrew, use the following command:

brew install alphabetum/taps/hosts

Usage

Usage:
  hosts
  hosts add <ip> <hostname> [comment]
  hosts remove ( <ip> | <hostname> | <search string> ) [--force]
  hosts list [enabled | disabled | <search string>]
  hosts show ( <ip> | <hostname> | <search string> )
  hosts disable ( <ip> | <hostname> | <search string> )
  hosts disabled
  hosts enable ( <ip> | <hostname> | <search string> )
  hosts enabled
  hosts edit
  hosts file

For full usage, run:

hosts help

For help with a particular command, try:

hosts help <command name>

Commands

`hosts add <ip> <hostname> [comment]`

Add a given IP address and hostname pair, along with an optional comment.

`hosts remove ( <ip> | <hostname> | <search string> ) [--force]`

Remove one or more records based on a given IP address, hostname, or search string. When the --force option is used, the confirmation prompt is supressed.

`hosts list [enabled | disabled | <search string>]`

List the existing IP / hostname pairs, optionally limited to a specified state. When provided with a seach string, all matching enabled records will be printed.

`hosts show ( <ip> | <hostname> | <search string> )`

Print entries matching a given IP address, hostname, or search string.

`hosts disable ( <ip> | <hostname> | <search string> )`

Disable one or more records based on a given ip address, hostname, or search string.

`hosts disabled`

List all disabled records. This is an alias for hosts list disabled.

`hosts enable ( <ip> | <hostname> | <search string> )`

Enable one or more disabled records based on a given ip address, hostname, or search string.

`hosts enabled`

List all enabled records. This is an alias for hosts list enabled.

`hosts edit`

Open the hosts file (/etc/hosts) file in your editor.

`hosts file`

Print the entire contents of the /etc/hosts file.

Why

Although it's easy to just edit the hosts file manually, it's nice to have a structured way to edit it and keep things a little organized.

Acknowledgements

Based on prior work by:

Original idea and interface (since changed) via:

https://github.com/macmade/host-manager