From 8c28fbcaa62c29d14854787a86ff8b3790d474b7 Mon Sep 17 00:00:00 2001 From: fluzzi Date: Sun, 17 Apr 2022 00:27:40 -0300 Subject: [PATCH] readme --- README.md | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 9ff8cbe..fa3456a 100644 --- a/README.md +++ b/README.md @@ -60,7 +60,19 @@ for i in result: mynodes.router1.run(["term len 0". "show run"], folder = "/home/user/logs") ``` -## Connection manager usage +## Connection manager +### Features +``` + - You can generate profiles and reference them from nodes using @profilename + so you dont need to edit multiple nodes when changing password or other + information. + - Nodes can be stored on @folder or @subfolder@folder to organize your + devices. Then can be referenced using node@subfolder@folder or node@folder + - If you have too many nodes. Get completion script using: conn config + --completion, or use fzf installing pyfzf and running conn -f + - Much more! +``` +### Usage: ``` usage: conn [-h] [--add | --del | --mod | --show | --debug] [node|folder] conn {profile,move,mv,copy,cp,list,ls,bulk,config} ... @@ -72,7 +84,7 @@ positional arguments: Show all available connections globaly or in specified path ``` -#### Options: +### Options: ``` -h, --help show this help message and exit -a, --add Add new node[@subfolder][@folder] or [@subfolder]@folder @@ -84,7 +96,7 @@ positional arguments: ``` -#### Commands: +### Commands: ``` profile Manage profiles move (mv) Move node @@ -94,7 +106,7 @@ positional arguments: config Manage app config ``` -#### Manage profiles: +### Manage profiles: ``` usage: conn profile [-h] (--add | --del | --mod | --show) profile