docs/connpy/cli/help_text.html

<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
<meta name="generator" content="pdoc3 0.11.5">
<title>connpy.cli.help_text API documentation</title>
<meta name="description" content="">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source > summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible;min-width:max-content}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin:1em 0}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>
<script>window.addEventListener('DOMContentLoaded', () => {
hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});
hljs.highlightAll();
/* Collapse source docstrings */
setTimeout(() => {
[...document.querySelectorAll('.hljs.language-python > .hljs-string')]
.filter(el => el.innerHTML.length > 200 && ['"""', "'''"].includes(el.innerHTML.substring(0, 3)))
.forEach(el => {
let d = document.createElement('details');
d.classList.add('hljs-string');
d.innerHTML = '<summary>"""</summary>' + el.innerHTML.substring(3);
el.replaceWith(d);
});
}, 100);
})</script>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>connpy.cli.help_text</code></h1>
</header>
<section id="section-intro">
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-functions">Functions</h2>
<dl>
<dt id="connpy.cli.help_text.get_help"><code class="name flex">
<span>def <span class="ident">get_help</span></span>(<span>type, parsers=None)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def get_help(type, parsers=None):
    if type == &#34;export&#34;:
        return &#34;Export /path/to/file.yml \[@subfolder1]\[@folder1] \[@subfolderN]\[@folderN]&#34;
    if type == &#34;import&#34;:
        return &#34;Import /path/to/file.yml&#34;
    if type == &#34;node&#34;:
        return &#34;node\[@subfolder]\[@folder]\nConnect to specific node or show all matching nodes\n\[@subfolder]\[@folder]\nShow all available connections globally or in specified path&#34;
    if type == &#34;usage&#34;:
        commands = []
        for subcommand, subparser in parsers.choices.items():
            if subparser.description != None:
                commands.append(subcommand)
        commands = &#34;,&#34;.join(commands)
        usage_help = f&#34;connpy [-h] [--add | --del | --mod | --show | --debug] [node|folder] [--sftp]\n       connpy {{{commands}}} ...&#34;
        return usage_help
    return get_instructions(type)</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="connpy.cli.help_text.get_instructions"><code class="name flex">
<span>def <span class="ident">get_instructions</span></span>(<span>type='add')</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def get_instructions(type=&#34;add&#34;):
    if type == &#34;add&#34;:
        return &#34;&#34;&#34;
Welcome to Connpy node Addition Wizard!

Here are some important instructions and tips for configuring your new node:

1. **Profiles**:
   - You can use the configured settings in a profile using `@profilename`.

2. **Available Protocols and Apps**:
   - ssh
   - telnet
   - kubectl (`kubectl exec`)
   - docker (`docker exec`)
   - ssm (`aws ssm start-session`)

3. **Optional Values**:
   - You can leave any value empty except for the hostname/IP.

4. **Passwords**:
   - You can pass one or more passwords using comma-separated `@profiles`.

5. **Logging**:
   - You can use the following variables in the logging file name:
     - `${id}`
     - `${unique}`
     - `${host}`
     - `${port}`
     - `${user}`
     - `${protocol}`

6. **Well-Known Tags**:
   - `os`: Identified by AI to generate commands based on the operating system.
   - `screen_length_command`: Used by automation to avoid pagination on different devices (e.g., `terminal length 0` for Cisco devices).
   - `prompt`: Replaces default app prompt to identify the end of output or where the user can start inputting commands.
   - `kube_command`: Replaces the default command (`/bin/bash`) for `kubectl exec`.
   - `docker_command`: Replaces the default command for `docker exec`.
&#34;&#34;&#34;
    if type == &#34;bashcompletion&#34;:
        return &#39;&#39;&#39;
# Bash completion for connpy
# Run: eval &#34;$(connpy config --completion bash)&#34;
# Or add it to your .bashrc

_connpy_autocomplete()
{
  local strings
  strings=$(python3 -m connpy.completion bash ${#COMP_WORDS[@]} &#34;${COMP_WORDS[@]}&#34;)
  
  local IFS=$&#39;\\t&#39;
  COMPREPLY=( $(compgen -W &#34;$strings&#34; -- &#34;${COMP_WORDS[$COMP_CWORD]}&#34;) )
}
complete -o nosort -F _connpy_autocomplete conn
complete -o nosort -F _connpy_autocomplete connpy
&#39;&#39;&#39;
    if type == &#34;zshcompletion&#34;:
        return &#39;&#39;&#39;
# Zsh completion for connpy
# Run: eval &#34;$(connpy config --completion zsh)&#34;
# Or add it to your .zshrc
# Make sure compinit is loaded

autoload -U compinit &amp;&amp; compinit
_connpy_autocomplete()
{
    local COMP_WORDS num strings
    COMP_WORDS=( $words )
    num=${#COMP_WORDS[@]}
    if [[ $words =~ &#39;.* $&#39; ]]; then
        num=$(($num + 1))
    fi
    strings=$(python3 -m connpy.completion zsh ${num} ${COMP_WORDS[@]})
    
    local IFS=$&#39;\\t&#39;
    compadd &#34;$@&#34; -- ${=strings}
}
compdef _connpy_autocomplete conn
compdef _connpy_autocomplete connpy
&#39;&#39;&#39;
    if type == &#34;fzf_wrapper_bash&#34;:
        return &#39;&#39;&#39;\n#Here starts bash 0ms fzf wrapper for connpy
connpy() {
    if [ $# -eq 0 ]; then
        local selected
        local configdir=$(cat ~/.config/conn/.folder 2&gt;/dev/null || echo ~/.config/conn)
        if [ -s &#34;$configdir/.fzf_nodes_cache.txt&#34; ]; then
            selected=$(cat &#34;$configdir/.fzf_nodes_cache.txt&#34; | fzf-tmux -i -d 25%)
        else
            command connpy
            return
        fi
        if [ -n &#34;$selected&#34; ]; then
            command connpy &#34;$selected&#34;
        fi
    else
        command connpy &#34;$@&#34;
    fi
}
alias c=&#34;connpy&#34;
#Here ends bash 0ms fzf wrapper for connpy
&#39;&#39;&#39;
    if type == &#34;fzf_wrapper_zsh&#34;:
        return &#39;&#39;&#39;\n#Here starts zsh 0ms fzf wrapper for connpy
connpy() {
    if [ $# -eq 0 ]; then
        local selected
        local configdir=$(cat ~/.config/conn/.folder 2&gt;/dev/null || echo ~/.config/conn)
        if [ -s &#34;$configdir/.fzf_nodes_cache.txt&#34; ]; then
            selected=$(cat &#34;$configdir/.fzf_nodes_cache.txt&#34; | fzf-tmux -i -d 25%)
        else
            command connpy
            return
        fi
        if [ -n &#34;$selected&#34; ]; then
            command connpy &#34;$selected&#34;
        fi
    else
        command connpy &#34;$@&#34;
    fi
}
alias c=&#34;connpy&#34;
#Here ends zsh 0ms fzf wrapper for connpy
&#39;&#39;&#39;
    if type == &#34;run&#34;:
        return &#34;node[@subfolder][@folder] commmand to run\nRun the specific command on the node and print output\n/path/to/file.yaml\nUse a yaml file to run an automation script&#34;
    if type == &#34;generate&#34;:
        return r&#39;&#39;&#39;---
tasks:
- name: &#34;Config&#34;

  action: &#39;run&#39; #Action can be test or run. Mandatory

  nodes: #List of nodes to work on. Mandatory
  - &#39;router1@office&#39; #You can add specific nodes
  - &#39;@aws&#39;  #entire folders or subfolders
  - &#39;@office&#39;:   #or filter inside a folder or subfolder
    - &#39;router2&#39;
    - &#39;router7&#39;

  commands: #List of commands to send, use {name} to pass variables
  - &#39;term len 0&#39;
  - &#39;conf t&#39;
  - &#39;interface {if}&#39;
  - &#39;ip address 10.100.100.{id} 255.255.255.255&#39;
  - &#39;{commit}&#39;
  - &#39;end&#39;

  variables: #Variables to use on commands and expected. Optional
    __global__: #Global variables to use on all nodes, fallback if missing in the node.
      commit: &#39;&#39;
      if: &#39;loopback100&#39;
    router1@office:
      id: 1
    router2@office:
      id: 2
      commit: &#39;commit&#39;
    router3@office:
      id: 3
    vrouter1@aws:
      id: 4
    vrouterN@aws:
      id: 5
  
  output: /home/user/logs #Type of output, if null you only get Connection and test result. Choices are: null,stdout,/path/to/folder. Folder path only works on &#39;run&#39; action.
  
  options:
    prompt: r&#39;&gt;$|#$|\$$|&gt;.$|#.$|\$.$&#39; #Optional prompt to check on your devices, default should work on most devices.
    parallel: 10 #Optional number of nodes to run commands on parallel. Default 10.
    timeout: 20 #Optional time to wait in seconds for prompt, expected or EOF. Default 20. 

- name: &#34;TestConfig&#34;
  action: &#39;test&#39;
  nodes:
  - &#39;router1@office&#39;
  - &#39;@aws&#39;
  - &#39;@office&#39;:
    - &#39;router2&#39;
    - &#39;router7&#39;
  commands:
  - &#39;ping 10.100.100.{id}&#39;
  expected: &#39;!&#39; #Expected text to find when running test action. Mandatory for &#39;test&#39;
  variables:
    router1@office:
      id: 1
    router2@office:
      id: 2
      commit: &#39;commit&#39;
    router3@office:
      id: 3
    vrouter1@aws:
      id: 4
    vrouterN@aws:
      id: 5
  output: null
...&#39;&#39;&#39;
    return &#34;&#34;</code></pre>
</details>
<div class="desc"></div>
</dd>
</dl>
</section>
<section>
</section>
</article>
<nav id="sidebar">
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3>Super-module</h3>
<ul>
<li><code><a title="connpy.cli" href="index.html">connpy.cli</a></code></li>
</ul>
</li>
<li><h3><a href="#header-functions">Functions</a></h3>
<ul class="">
<li><code><a title="connpy.cli.help_text.get_help" href="#connpy.cli.help_text.get_help">get_help</a></code></li>
<li><code><a title="connpy.cli.help_text.get_instructions" href="#connpy.cli.help_text.get_instructions">get_instructions</a></code></li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.5</a>.</p>
</footer>
</body>
</html>
feat: major architectural refactor to 5.1b1 - Service Layer, gRPC & Agent evolution (fragmented secrets) 2026-04-17 18:42:08 -03:00			`<!doctype html>`
			`<html lang="en">`
			`<head>`
			`<meta charset="utf-8">`
			`<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">`
feat: Implement Smart Tunnel async architecture (v6.0.0b1) 2026-04-27 15:12:07 -03:00			`<meta name="generator" content="pdoc3 0.11.5">`
feat: major architectural refactor to 5.1b1 - Service Layer, gRPC & Agent evolution (fragmented secrets) 2026-04-17 18:42:08 -03:00			`<title>connpy.cli.help_text API documentation</title>`
			`<meta name="description" content="">`
			`<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>`
			`<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>`
			`<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>`
			<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > :last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source > summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > {white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible;min-width:max-content}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin:1em 0}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
			`<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>`
			<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
			`<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>`
			`<script>window.addEventListener('DOMContentLoaded', () => {`
			`hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});`
			`hljs.highlightAll();`
			`/* Collapse source docstrings */`
			`setTimeout(() => {`
			`[...document.querySelectorAll('.hljs.language-python > .hljs-string')]`
			`.filter(el => el.innerHTML.length > 200 && ['"""', "'''"].includes(el.innerHTML.substring(0, 3)))`
			`.forEach(el => {`
			`let d = document.createElement('details');`
			`d.classList.add('hljs-string');`
			`d.innerHTML = '<summary>"""</summary>' + el.innerHTML.substring(3);`
			`el.replaceWith(d);`
			`});`
			`}, 100);`
			`})</script>`
			`</head>`
			`<body>`
			`<main>`
			`<article id="content">`
			`<header>`
			`<h1 class="title">Module <code>connpy.cli.help_text</code></h1>`
			`</header>`
			`<section id="section-intro">`
			`</section>`
			`<section>`
			`</section>`
			`<section>`
			`</section>`
			`<section>`
			`<h2 class="section-title" id="header-functions">Functions</h2>`
			`<dl>`
			`<dt id="connpy.cli.help_text.get_help"><code class="name flex">`
			`<span>def <span class="ident">get_help</span></span>(<span>type, parsers=None)</span>`
			`</code></dt>`
			`<dd>`
			`<details class="source">`
			`<summary>`
			`<span>Expand source code</span>`
			`</summary>`
			`<pre><code class="python">def get_help(type, parsers=None):`
			`if type == "export":`
			`return "Export /path/to/file.yml \[@subfolder1]\[@folder1] \[@subfolderN]\[@folderN]"`
			`if type == "import":`
			`return "Import /path/to/file.yml"`
			`if type == "node":`
			`return "node\[@subfolder]\[@folder]\nConnect to specific node or show all matching nodes\n\[@subfolder]\[@folder]\nShow all available connections globally or in specified path"`
			`if type == "usage":`
			`commands = []`
			`for subcommand, subparser in parsers.choices.items():`
			`if subparser.description != None:`
			`commands.append(subcommand)`
			`commands = ",".join(commands)`
			`usage_help = f"connpy [-h] [--add \| --del \| --mod \| --show \| --debug] [node\|folder] [--sftp]\n connpy {{{commands}}} ..."`
			`return usage_help`
			`return get_instructions(type)</code></pre>`
			`</details>`
			`<div class="desc"></div>`
			`</dd>`
			`<dt id="connpy.cli.help_text.get_instructions"><code class="name flex">`
			`<span>def <span class="ident">get_instructions</span></span>(<span>type='add')</span>`
			`</code></dt>`
			`<dd>`
			`<details class="source">`
			`<summary>`
			`<span>Expand source code</span>`
			`</summary>`
			`<pre><code class="python">def get_instructions(type="add"):`
			`if type == "add":`
			`return """`
			`Welcome to Connpy node Addition Wizard!`

			`Here are some important instructions and tips for configuring your new node:`

			`1. Profiles:`
			- You can use the configured settings in a profile using `@profilename`.

			`2. Available Protocols and Apps:`
			`- ssh`
			`- telnet`
			- kubectl (`kubectl exec`)
			- docker (`docker exec`)
refactor: Major upgrade to v5.1b6 - AWS SSM support & Distributed Architecture 2026-04-24 19:23:00 -03:00			- ssm (`aws ssm start-session`)
feat: major architectural refactor to 5.1b1 - Service Layer, gRPC & Agent evolution (fragmented secrets) 2026-04-17 18:42:08 -03:00
			`3. Optional Values:`
			`- You can leave any value empty except for the hostname/IP.`

			`4. Passwords:`
			- You can pass one or more passwords using comma-separated `@profiles`.

			`5. Logging:`
			`- You can use the following variables in the logging file name:`
			- `${id}`
			- `${unique}`
			- `${host}`
			- `${port}`
			- `${user}`
			- `${protocol}`

			`6. Well-Known Tags:`
			- `os`: Identified by AI to generate commands based on the operating system.
			- `screen_length_command`: Used by automation to avoid pagination on different devices (e.g., `terminal length 0` for Cisco devices).
			- `prompt`: Replaces default app prompt to identify the end of output or where the user can start inputting commands.
			- `kube_command`: Replaces the default command (`/bin/bash`) for `kubectl exec`.
			- `docker_command`: Replaces the default command for `docker exec`.
			`"""`
			`if type == "bashcompletion":`
			`return '''`
			`# Bash completion for connpy`
			`# Run: eval "$(connpy config --completion bash)"`
			`# Or add it to your .bashrc`

			`_connpy_autocomplete()`
			`{`
			`local strings`
			`strings=$(python3 -m connpy.completion bash ${#COMP_WORDS[@]} "${COMP_WORDS[@]}")`

			`local IFS=$'\\t'`
			`COMPREPLY=( $(compgen -W "$strings" -- "${COMP_WORDS[$COMP_CWORD]}") )`
			`}`
			`complete -o nosort -F _connpy_autocomplete conn`
			`complete -o nosort -F _connpy_autocomplete connpy`
			`'''`
			`if type == "zshcompletion":`
			`return '''`
			`# Zsh completion for connpy`
			`# Run: eval "$(connpy config --completion zsh)"`
			`# Or add it to your .zshrc`
			`# Make sure compinit is loaded`

			`autoload -U compinit && compinit`
			`_connpy_autocomplete()`
			`{`
			`local COMP_WORDS num strings`
			`COMP_WORDS=( $words )`
			`num=${#COMP_WORDS[@]}`
			`if [[ $words =~ '.* $' ]]; then`
			`num=$(($num + 1))`
			`fi`
			`strings=$(python3 -m connpy.completion zsh ${num} ${COMP_WORDS[@]})`

			`local IFS=$'\\t'`
			`compadd "$@" -- ${=strings}`
			`}`
			`compdef _connpy_autocomplete conn`
			`compdef _connpy_autocomplete connpy`
			`'''`
			`if type == "fzf_wrapper_bash":`
			`return '''\n#Here starts bash 0ms fzf wrapper for connpy`
			`connpy() {`
			`if [ $# -eq 0 ]; then`
			`local selected`
			`local configdir=$(cat ~/.config/conn/.folder 2>/dev/null \|\| echo ~/.config/conn)`
			`if [ -s "$configdir/.fzf_nodes_cache.txt" ]; then`
			`selected=$(cat "$configdir/.fzf_nodes_cache.txt" \| fzf-tmux -i -d 25%)`
			`else`
			`command connpy`
			`return`
			`fi`
			`if [ -n "$selected" ]; then`
			`command connpy "$selected"`
			`fi`
			`else`
			`command connpy "$@"`
			`fi`
			`}`
			`alias c="connpy"`
			`#Here ends bash 0ms fzf wrapper for connpy`
			`'''`
			`if type == "fzf_wrapper_zsh":`
			`return '''\n#Here starts zsh 0ms fzf wrapper for connpy`
			`connpy() {`
			`if [ $# -eq 0 ]; then`
			`local selected`
			`local configdir=$(cat ~/.config/conn/.folder 2>/dev/null \|\| echo ~/.config/conn)`
			`if [ -s "$configdir/.fzf_nodes_cache.txt" ]; then`
			`selected=$(cat "$configdir/.fzf_nodes_cache.txt" \| fzf-tmux -i -d 25%)`
			`else`
			`command connpy`
			`return`
			`fi`
			`if [ -n "$selected" ]; then`
			`command connpy "$selected"`
			`fi`
			`else`
			`command connpy "$@"`
			`fi`
			`}`
			`alias c="connpy"`
			`#Here ends zsh 0ms fzf wrapper for connpy`
			`'''`
			`if type == "run":`
			`return "node[@subfolder][@folder] commmand to run\nRun the specific command on the node and print output\n/path/to/file.yaml\nUse a yaml file to run an automation script"`
			`if type == "generate":`
			`return r'''---`
			`tasks:`
			`- name: "Config"`

			`action: 'run' #Action can be test or run. Mandatory`

			`nodes: #List of nodes to work on. Mandatory`
			`- 'router1@office' #You can add specific nodes`
			`- '@aws' #entire folders or subfolders`
			`- '@office': #or filter inside a folder or subfolder`
			`- 'router2'`
			`- 'router7'`

			`commands: #List of commands to send, use {name} to pass variables`
			`- 'term len 0'`
			`- 'conf t'`
			`- 'interface {if}'`
			`- 'ip address 10.100.100.{id} 255.255.255.255'`
			`- '{commit}'`
			`- 'end'`

			`variables: #Variables to use on commands and expected. Optional`
			`__global__: #Global variables to use on all nodes, fallback if missing in the node.`
			`commit: ''`
			`if: 'loopback100'`
			`router1@office:`
			`id: 1`
			`router2@office:`
			`id: 2`
			`commit: 'commit'`
			`router3@office:`
			`id: 3`
			`vrouter1@aws:`
			`id: 4`
			`vrouterN@aws:`
			`id: 5`

			`output: /home/user/logs #Type of output, if null you only get Connection and test result. Choices are: null,stdout,/path/to/folder. Folder path only works on 'run' action.`

			`options:`
			`prompt: r'>$\|#$\|\$$\|>.$\|#.$\|\$.$' #Optional prompt to check on your devices, default should work on most devices.`
			`parallel: 10 #Optional number of nodes to run commands on parallel. Default 10.`
			`timeout: 20 #Optional time to wait in seconds for prompt, expected or EOF. Default 20.`

			`- name: "TestConfig"`
			`action: 'test'`
			`nodes:`
			`- 'router1@office'`
			`- '@aws'`
			`- '@office':`
			`- 'router2'`
			`- 'router7'`
			`commands:`
			`- 'ping 10.100.100.{id}'`
			`expected: '!' #Expected text to find when running test action. Mandatory for 'test'`
			`variables:`
			`router1@office:`
			`id: 1`
			`router2@office:`
			`id: 2`
			`commit: 'commit'`
			`router3@office:`
			`id: 3`
			`vrouter1@aws:`
			`id: 4`
			`vrouterN@aws:`
			`id: 5`
			`output: null`
			`...'''`
			`return ""</code></pre>`
			`</details>`
			`<div class="desc"></div>`
			`</dd>`
			`</dl>`
			`</section>`
			`<section>`
			`</section>`
			`</article>`
			`<nav id="sidebar">`
			`<div class="toc">`
			`<ul></ul>`
			`</div>`
			`<ul id="index">`
			`<li><h3>Super-module</h3>`
			`<ul>`
			`<li><code><a title="connpy.cli" href="index.html">connpy.cli</a></code></li>`
			`</ul>`
			`</li>`
			`<li><h3><a href="#header-functions">Functions</a></h3>`
			`<ul class="">`
			`<li><code><a title="connpy.cli.help_text.get_help" href="#connpy.cli.help_text.get_help">get_help</a></code></li>`
			`<li><code><a title="connpy.cli.help_text.get_instructions" href="#connpy.cli.help_text.get_instructions">get_instructions</a></code></li>`
			`</ul>`
			`</li>`
			`</ul>`
			`</nav>`
			`</main>`
			`<footer id="footer">`
feat: Implement Smart Tunnel async architecture (v6.0.0b1) 2026-04-27 15:12:07 -03:00			`<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.5</a>.</p>`
feat: major architectural refactor to 5.1b1 - Service Layer, gRPC & Agent evolution (fragmented secrets) 2026-04-17 18:42:08 -03:00			`</footer>`
			`</body>`
			`</html>`