README

Hosts Manager is a utility to quickly and easily manage hosts in your hosts file.

Requirements

Composer
php 5.4+

Installation

Run git clone git@github.com:xFlatlinex/hosts.git to clone the repo.
Run composer install to install dependencies.

At this point you should be able to run it like this php bin/hosts.

Global installation

There are two ways to install it. Using composer global or compile the phar and move it to your corresponding bin dir. Note that both methods need composer, but the first one needs composer to be installed globally.

After you install it you should be able to run it directly:

$ hosts add somehost

With Composer installed globally

First, make sure you have ~/.composer/vendor/bin/ in your path.
Then run the following composer command:

$ composer global require 'flatline/hosts=dev-master'

With Composer phar

This way, you need to compile it to a single phar file and then copy it to /usr/local/bin.

Clone the repo and install dependencies.
Generate hosts.phar by running php bin/compile
Run sudo cp hosts.phar /usr/local/bin/hosts
Make it executable sudo chmod a+x /usr/local/bin/hosts

Usage

To get a list of options and commands run hosts without any parameters.

Currently available commands:

Run hosts add [hostname] [options] to add a host
Run hosts toggle [hostname] [options] to enable/disable a host
Run hosts show [options] to show a list of hosts
Run hosts remove [options] to remove a host from the hosts file

All of the commands have several options and filters, you can check them out by running hosts help [command].

Contributing

This is a work in progress, I'll be adding more commands and modifying existing ones.
This project was built to suit my needs, but if it helps you as well, fantastic! Feel free to contribute with new functionality and/or fixes!

License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

flatline / hosts

Maintainers

Details