guumaster / hostctl

Your dev tool to manage /etc/hosts like a pro!
http://guumaster.github.io/hostctl
MIT License
1.04k stars 45 forks source link

Documentation update to include the structure output of each command #98

Open gnud opened 1 month ago

gnud commented 1 month ago

Is your feature request related to a problem? Please describe. I'd like a clear picture of what command will render in the file, and how to prepare my /etc/hosts file before installing this tool (if needed).

Describe the solution you'd like An update of the documentation description each of the operations what they will render, like 'add', 'remove', 'enable/disable profile'

Describe alternatives you've considered For example, a table in the Readme showing each of the commands and what will render in the file. What's the target audience: people who don't have time to read the instructions for the add command and don't know how to prepare the hosts file correctly in order to work with this tool.

Additional context

Examples:

hostctl --ip localhost add domains myprofile bla.com

will render:

# profile.on myprofile
localhost bla.com
# end

hosts enable myprofile

will render:

# profile.on myprofile
# data here for each hosts entry
# end

hosts disable myprofile

will render:

# profile.off myprofile
# data here for each hosts entry
# end

hosts remove myprofile

will remove the structure of the file.

This way without making backups users will be confident on the output that will rendered.