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>
      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 enable ( <ip> | <hostname> | <search string> )
      hosts edit
      hosts file

For full usage, run:

    hosts help

For help with a particular command, try:

    hosts help <command name>

## 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`
Clarify usage information 2015-03-17 00:26:58 +00:00			`hosts add <ip> <hostname>`
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> )`
			`hosts enable ( <ip> \| <hostname> \| <search string> )`
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 '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`