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

- https://github.com/nddrylliog
  - https://gist.github.com/nddrylliog/1368532
- https://github.com/dfeyer
  - https://gist.github.com/dfeyer/1369760

Original idea and interface (since changed) via:

https://github.com/macmade/host-manager
Add initial Readme with basic information. 2015-03-17 00:05:46 +00:00			`# Hosts`

Expand Readme slightly. 2015-03-17 03:13:19 +00:00			`A command line program with shortcuts for managing hosts file entries.`
Add initial Readme with basic information. 2015-03-17 00:05:46 +00:00
Add installation information to Readme. 2015-03-19 01:35:45 +00:00			`## 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`

Add initial Readme with basic information. 2015-03-17 00:05:46 +00:00			`## Usage`

			`Usage:`
Prompt user in `remove` In order to avoid mistakes, prompt the user when removing records. Allow skipping of the prompt using the --force option. 2015-03-19 01:19:52 +00:00			`hosts`
Add ability to add an option comment when adding a record This addition requires a number of changes including: - the addition of a new `_join` function - reformatting of the `add` function to facilitate the longer lines 2015-03-21 01:06:00 +00:00			`hosts add <ip> <hostname> [comment]`
Use 'search string' consistently instead of mixing with 'search term' 2015-03-19 01:22:37 +00:00			`hosts remove ( <ip> \| <hostname> \| <search string> ) [--force]`
Add 'enabled' and 'disabled' options to `list` These return records that have the status specified in the option. 2015-03-19 00:04:39 +00:00			`hosts list [enabled \| disabled \| <search string>]`
Add `show` command and use that for `list` searches Displaying a record pair for a hostname or IP address is likely a common operation, and using the `show` name makes it clear what the primary function of the command is. Since record pairs are very simple, the easiest way to allow both hostname and ip address arguments is to use grep, which also provides general search-like functionality. In order to avoid doubling this functionality, use the `show` command in the `list` command for search. 2015-03-18 23:07:49 +00:00			`hosts show ( <ip> \| <hostname> \| <search string> )`
Use 'search string' consistently instead of mixing with 'search term' 2015-03-19 01:22:37 +00:00			`hosts disable ( <ip> \| <hostname> \| <search string> )`
Add `enabled` and `disabled` commands. Both of these are just aliases for the `list ( enabled \| disabled )` commands, providing a shorter way to access the same functionality. 2015-03-20 23:44:43 +00:00			`hosts disabled`
Use 'search string' consistently instead of mixing with 'search term' 2015-03-19 01:22:37 +00:00			`hosts enable ( <ip> \| <hostname> \| <search string> )`
Add `enabled` and `disabled` commands. Both of these are just aliases for the `list ( enabled \| disabled )` commands, providing a shorter way to access the same functionality. 2015-03-20 23:44:43 +00:00			`hosts enabled`
Add `edit` command `edit` open the hosts file in the editor specified in the $EDITOR environment variable. 2015-03-17 00:38:06 +00:00			`hosts edit`
Add `hosts file` command to Readme. 2015-03-17 02:56:16 +00:00			`hosts file`
Add acknowledgements sections for script and Readme 2015-03-17 00:19:17 +00:00
Expand Readme slightly. 2015-03-17 03:13:19 +00:00			`For full usage, run:`

			`hosts help`

Clarify help command usage in Readme. 2015-03-19 01:23:59 +00:00			`For help with a particular command, try:`
Expand Readme slightly. 2015-03-17 03:13:19 +00:00
			`hosts help <command name>`

Add command information to Readme 2015-03-19 21:43:32 +00:00			`## Commands`

Add ability to add an option comment when adding a record This addition requires a number of changes including: - the addition of a new `_join` function - reformatting of the `add` function to facilitate the longer lines 2015-03-21 01:06:00 +00:00			###### `hosts add <ip> <hostname> [comment]`
Add command information to Readme 2015-03-19 21:43:32 +00:00
Add ability to add an option comment when adding a record This addition requires a number of changes including: - the addition of a new `_join` function - reformatting of the `add` function to facilitate the longer lines 2015-03-21 01:06:00 +00:00			`Add a given IP address and hostname pair, along with an optional comment.`
Add command information to Readme 2015-03-19 21:43:32 +00:00
			###### `hosts remove ( <ip> \| <hostname> \| <search string> ) [--force]`

Correct typo in `help` usage + add info about `--force` in Readme 2015-03-20 00:14:04 +00:00			`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.`
Add command information to Readme 2015-03-19 21:43:32 +00:00
			###### `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.`

Add `enabled` and `disabled` commands. Both of these are just aliases for the `list ( enabled \| disabled )` commands, providing a shorter way to access the same functionality. 2015-03-20 23:44:43 +00:00			###### `hosts disabled`

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

Add command information to Readme 2015-03-19 21:43:32 +00:00			###### `hosts enable ( <ip> \| <hostname> \| <search string> )`

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

Add `enabled` and `disabled` commands. Both of these are just aliases for the `list ( enabled \| disabled )` commands, providing a shorter way to access the same functionality. 2015-03-20 23:44:43 +00:00			###### `hosts enabled`

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

Add command information to Readme 2015-03-19 21:43:32 +00:00			###### `hosts edit`

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

			###### `hosts file`

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

Add 'Why' section to Readme 2015-03-19 01:44:06 +00:00			`## 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.`

Add acknowledgements sections for script and Readme 2015-03-17 00:19:17 +00:00			`## Acknowledgements`

			`Based on prior work by:`

			`- https://github.com/nddrylliog`
			`- https://gist.github.com/nddrylliog/1368532`
			`- https://github.com/dfeyer`
			`- https://gist.github.com/dfeyer/1369760`

			`Original idea and interface (since changed) via:`

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