Update usage info in the docs (#116)

Author: pythoninja

CHANGELOG.md

@@ -8,12 +8,26 @@ All notable changes to this project will be documented in this file.
 
 - Show skipped and processed hosts in output - ([a5fdcbe](https://github.com/pythoninja/sshgen/commit/a5fdcbe810d246ac0e9af97ed901b50da95ace2f))
 
+### Refactor
+
+- Change create and writing methods - ([332c63c](https://github.com/pythoninja/sshgen/commit/332c63c547299e1db246b81a205d76fc3ee6f280))
+
 ### Development
 
+- *(dev)* Ignore test files - ([9ac9b86](https://github.com/pythoninja/sshgen/commit/9ac9b8661e5e6956fdc97e01b34b106be71d7e6c))
+- *(dev)* Add justfile - ([6b5541e](https://github.com/pythoninja/sshgen/commit/6b5541ebb27bfaaa5b2d5130282358119bbcd35f))
+- *(dev)* Enable ruff-specific rules for linter - ([98b901c](https://github.com/pythoninja/sshgen/commit/98b901c837a130007f9c91ab4e0f1642559b728d))
+- *(dev)* Format the code on pre-commit - ([378e9c2](https://github.com/pythoninja/sshgen/commit/378e9c27cefd51677ab8636b69a0b0c10a7bf7ce))
 - *(dev)* Change ruff linter and formatter rules - ([783ba11](https://github.com/pythoninja/sshgen/commit/783ba115bce9c416f25c5b691e6d949e41173de5))
 - *(dev)* Update python to 3.12 - ([6c9166a](https://github.com/pythoninja/sshgen/commit/6c9166a25bea7ab82451a00be17333acd8b346fc))
 - *(dev)* Update to ruff 0.3.1 - ([f05ee2e](https://github.com/pythoninja/sshgen/commit/f05ee2e1ce926dd182106d1e1472160561ee3240))
 
+### Documentation
+
+- *(changelog)* Update release notes - ([f6d1323](https://github.com/pythoninja/sshgen/commit/f6d1323c767b93d1034bdea17a73e783fd7a50e8))
+- Update usage and output example - ([6a5dda4](https://github.com/pythoninja/sshgen/commit/6a5dda4b631b4830cc2e39db4132e3849e9d5a24))
+- Update example usage in cli - ([c20477a](https://github.com/pythoninja/sshgen/commit/c20477a55c9b67e42ede4085828a1288ee6aa777))
+
 ## [0.5.0](https://github.com/pythoninja/sshgen/compare/v0.4.0..v0.5.0) - 2023-12-19
 
 ### Features

README.md

@@ -23,7 +23,7 @@ Current version: v0.5.0
 
 ## Features
 
-1. Generates a `config` file to merge with your existing SSH configuration.
+1. Generates a `config` file to merge with your existing SSH configuration or include as a separate `.conf` file (since v0.6.0).
 2. Custom configuration for ssh-agent.
 3. Custom SSH aliases for quick connections.
 4. Skip selected hosts from results file.
@@ -125,7 +125,8 @@ SSHGEN_DEBUG=1 sshgen generate
 After executing the command, you will see the following output:
 
 ```text
-[INFO] - Generated SSH config file was saved to /my_dir/config
+[2024-03-10 10:00:00] [INFO] - Generated SSH config file was saved to /my_dir/config
+[2024-03-10 10:00:00] [INFO] - Total processed hosts: 3, total skipped hosts: 1
 ```
 
 Check the file contents `cat /my_dir/config`:
@@ -151,37 +152,52 @@ Host host4 postgres-server # group2
     IdentityAgent ~/.1password/agent.sock
 ```
 
-If you ran using verbose mode, you should see additional information:
+If you run using verbose mode, you should see additional information:
 
 <details><summary>Verbose output example</summary>
 <p>
 
 ```text
-[2023-10-21 17:53:31] [DEBUG] - Loading ansible hosts file: /home/user/code/python/sshgen/examples/hosts.yml
-[2023-10-21 17:53:31] [DEBUG] - Total hosts found (include skipped): 4
-[2023-10-21 17:53:31] [DEBUG] - Using template file /home/user/code/python/sshgen/sshgen/templates/ssh_config.template to generate ssh config
-[2023-10-21 17:53:31] [DEBUG] - Filtering hosts where _skip metafield was defined
-[2023-10-21 17:53:31] [DEBUG] - Host host1 should be skipped: False
-[2023-10-21 17:53:31] [DEBUG] - Host host2 should be skipped: True
-[2023-10-21 17:53:31] [DEBUG] - Host host3 should be skipped: False
-[2023-10-21 17:53:31] [DEBUG] - Host host4 should be skipped: False
-[2023-10-21 17:53:31] [DEBUG] - Processing host1 from group group1
-[2023-10-21 17:53:31] [DEBUG] - Adding SSH port 22 for host host1
-[2023-10-21 17:53:31] [DEBUG] - Adding aliases ['base', 'another-alias'] for host host1
-[2023-10-21 17:53:31] [DEBUG] - Adding custom auth methods for host host1
-[2023-10-21 17:53:31] [DEBUG] - Processing host3 from group group2
-[2023-10-21 17:53:31] [DEBUG] - Adding SSH port 19222 for host host3
-[2023-10-21 17:53:31] [DEBUG] - Processing host4 from group group2
-[2023-10-21 17:53:31] [DEBUG] - Adding SSH port 22 for host host4
-[2023-10-21 17:53:31] [DEBUG] - Adding aliases ['postgres-server'] for host host4
-[2023-10-21 17:53:31] [DEBUG] - Adding custom auth methods for host host4
-[2023-10-21 17:53:31] [INFO] - Generated SSH config file was saved to /home/user/code/python/sshgen/config
+[2024-03-10 10:00:00] [DEBUG] - Loading ansible hosts file: /home/user/code/python/sshgen/examples/hosts.yml
+[2024-03-10 10:00:00] [DEBUG] - Total hosts found (include skipped): 4
+[2024-03-10 10:00:00] [DEBUG] - Using template file /home/user/code/python/sshgen/sshgen/templates/ssh_config.template to generate ssh config
+[2024-03-10 10:00:00] [DEBUG] - Filtering hosts where _skip metafield was defined
+[2024-03-10 10:00:00] [DEBUG] - Host host1 should be skipped: False
+[2024-03-10 10:00:00] [DEBUG] - Host host2 should be skipped: True
+[2024-03-10 10:00:00] [DEBUG] - Host host3 should be skipped: False
+[2024-03-10 10:00:00] [DEBUG] - Host host4 should be skipped: False
+[2024-03-10 10:00:00] [DEBUG] - Processing host1 from group group1
+[2024-03-10 10:00:00] [DEBUG] - Adding SSH port 22 for host host1
+[2024-03-10 10:00:00] [DEBUG] - Adding aliases ['base', 'another-alias'] for host host1
+[2024-03-10 10:00:00] [DEBUG] - Adding custom auth methods for host host1
+[2024-03-10 10:00:00] [DEBUG] - Processing host3 from group group2
+[2024-03-10 10:00:00] [DEBUG] - Adding SSH port 19222 for host host3
+[2024-03-10 10:00:00] [DEBUG] - Processing host4 from group group2
+[2024-03-10 10:00:00] [DEBUG] - Adding SSH port 22 for host host4
+[2024-03-10 10:00:00] [DEBUG] - Adding aliases ['base', 'another-alias'] for host host4
+[2024-03-10 10:00:00] [DEBUG] - Adding custom auth methods for host host4
+[2024-03-10 10:00:00] [INFO] - Generated SSH config file was saved to /home/user/code/python/sshgen/config
+[2024-03-10 10:00:00] [DEBUG] - Skipped hosts list: 127.0.0.2
+[2024-03-10 10:00:00] [INFO] - Total processed hosts: 3, total skipped hosts: 1
 ```
 
 </p>
 </details>
 
-Copy and insert the output into your `~/.ssh/config` file. After that, you can use any of the defined aliases to SSH
+There are two ways to use the generated file:
+1. Copy and insert the output into your `~/.ssh/config` file.
+2. Copy file to the conf directory, e.g. `~/.ssh/config.d/00-custom.conf` (if it's not exist, create one).
+Edit your `~/.ssh/config` and add `Include` directive **to the top**:
+
+```
+#### Custom configuration
+
+Include ~/.ssh/config.d/*.conf
+
+#### End of custom configuration
+```
+
+After that, you can use any of the defined aliases to SSH
 into the corresponding hosts. For example, running `ssh base` will connect you to the host with the IP address 127.0.0.1
 as the root user and utilizing 1password as your SSH agent.
 

sshgen/cli.py

@@ -19,9 +19,8 @@ def generate_hosts_file(
 ) -> None:
     """
     Command to generate SSH configuration file.
-    By default, it uses file hosts.yml placed in your working directory and outputs to the file named "config"
-
-    Example usage: sshconf generate -o my_ssh_config
+    By default, it uses file hosts.yml placed in your working directory and outputs to the file named "config".
+    Example usage: sshgen generate -o my_ssh_config
     """
 
     hosts_file = FileUtils.get_hosts_path(file_path=hosts_file)