sshplex 1.6.1__tar.gz → 1.6.3__tar.gz

{sshplex-1.6.1/sshplex.egg-info → sshplex-1.6.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sshplex
-Version: 1.6.1
+Version: 1.6.3
 Summary: Multiplex your SSH connections with style
 Author-email: MJAHED Sabri <contact@sabrimjahed.com>
 License: MIT
@@ -61,12 +61,20 @@ SSHplex is a Python-based SSH connection multiplexer with a modern TUI. Connect
 
 - 🖥️ **Modern TUI** - Textual-based host selector with search, sort, and multi-select
 - 🔌 **Multiple Sources** - NetBox, Ansible, Consul, static lists - use them together
-- 📦 **3 Backends** - tmux standalone, tmux + iTerm2, or iTerm2 native (macOS)
-- ✏️ **Config Editor** - Built-in YAML editor with validation (`e` key)
+- 📦 **3 Mux Backends** - tmux standalone, tmux + iTerm2, or iTerm2 native (macOS)
+- ✏️ **Config Editor** - Built-in editor with compact source cards, static host rows, and full YAML pane
 - 🔄 **Broadcast Input** - Sync commands across multiple SSH sessions
 - 🔐 **SSH Security** - Configurable host key checking and retry logic
 - 🚀 **Fast Startup** - Intelligent caching with configurable TTL
 
+## What Is New in QoL v2
+
+- **Static host manager in UI** - Add and edit static hosts as rows (`name`, `ip`, `alias`, `user`, `port`, `key_path`) instead of raw YAML blobs.
+- **Per-host SSH preview** - Preview effective SSH values from `ssh -G` in settings and from host selector (`o`).
+- **Smarter table columns** - Detect columns from live hosts/cache/imports, including SSH-oriented fields like `alias`, `user`, `port`, and `key_path`.
+- **Better Sources UX** - Provider toggles and collapsible import cards make large source configs easier to navigate.
+- **Rich YAML view** - Side-by-side YAML edit + syntax-highlight preview for full config inspection.
+
 ## Quick Start
 
 ```bash
@@ -83,24 +91,9 @@ sshplex
 ### Prerequisites
 
 - Python 3.8+
-- tmux (Linux/macOS) or iTerm2 (macOS)
+- tmux (Linux/macOS) and/or iTerm2 (macOS)
 - SSH key configured for target hosts
 
-## Usage
-
-| Key | Action |
-|-----|--------|
-| `Space` | Toggle host selection |
-| `a` / `d` | Select / Deselect all |
-| `Enter` | Connect to selected hosts |
-| `/` | Search/filter hosts |
-| `p` | Toggle panes/tabs mode |
-| `b` | Toggle broadcast mode |
-| `e` | Open config editor |
-| `s` | Open session manager |
-| `h` | Show keyboard shortcuts |
-| `q` | Quit |
-
 ## Multiplexer Backends
 
 | Backend | Platform | Best For |
@@ -109,58 +102,17 @@ sshplex
 | **tmux + iTerm2** | macOS | Native UI + persistence |
 | **iTerm2 native** | macOS | Simple setup, no tmux dependency |
 
-```yaml
-# ~/.config/sshplex/sshplex.yaml
-tmux:
-  backend: "tmux"  # or "iterm2-native" on macOS
-  layout: "tiled"
-  max_panes_per_window: 5
-```
-
 ## Sources of Truth
 
-### Static Hosts
-```yaml
-sot:
-  import:
-    - name: "my-servers"
-      type: static
-      hosts:
-        - {name: "web-01", ip: "192.168.1.10", tags: ["web"]}
-```
+| Provider | `type` | Extra Dependency | Best For |
+|----------|--------|------------------|----------|
+| **Static** | `static` | None | Small lists, lab hosts, quick manual entries |
+| **NetBox** | `netbox` | None (included in base install) | Inventory-driven infrastructure with metadata |
+| **Ansible** | `ansible` | None | Reusing existing Ansible inventory files |
+| **Consul** | `consul` | `pip install "sshplex[consul]"` | Service discovery and dynamic node catalogs |
 
-### NetBox
-```yaml
-sot:
-  import:
-    - name: "prod"
-      type: netbox
-      url: "https://netbox.example.com/"
-      token: "your-api-token"
-```
+Provider activation is controlled by `sot.providers`, and each source is configured as an item in `sot.import`.
 
-### Ansible
-```yaml
-sot:
-  import:
-    - name: "inventory"
-      type: ansible
-      inventory_paths: ["/path/to/inventory.yml"]
-```
-
-### Consul
-```bash
-pip install "sshplex[consul]"
-```
-```yaml
-sot:
-  import:
-    - name: "dc1"
-      type: consul
-      config:
-        host: "consul.example.com"
-        token: "your-token"
-```
 
 ## Local Demo (Consul + Ansible)
 
@@ -179,45 +131,12 @@ Demo files:
 - `demo/docker-compose.consul-demo.yml`
 - `demo/sshplex.demo.yaml`
 
-Example config snippet:
-
-```yaml
-sot:
-  providers: ["ansible", "consul"]
-  import:
-    - name: "demo-ansible"
-      type: ansible
-      inventory_paths:
-        - "demo/ansible-inventory-demo.yml"
-
-    - name: "demo-consul"
-      type: consul
-      config:
-        host: "127.0.0.1"
-        port: 8500
-        token: ""
-        scheme: "http"
-        verify: false
-        dc: "dc1"
-```
-
 Run with the bundled demo config:
 
 ```bash
 sshplex --config demo/sshplex.demo.yaml
 ```
 
-## CLI Reference
-
-```bash
-sshplex                        # Launch TUI
-sshplex --onboarding           # Interactive setup wizard
-sshplex --debug                # Test provider connectivity
-sshplex --show-config          # Show config paths
-sshplex --clear-cache          # Clear host cache
-sshplex --config /path/to.yml  # Use custom config
-```
-
 ## Documentation
 
 | Guide | Description |
@@ -232,14 +151,8 @@ sshplex --config /path/to.yml  # Use custom config
 # Basic (tmux only)
 pip install sshplex
 
-# With Consul support
-pip install "sshplex[consul]"
-
-# With iTerm2 native support (macOS)
-pip install "sshplex[iterm2]"
-
-# Development
-pip install -e ".[dev]"
+# With Consul,DEV,Iterm2 support
+pip install "sshplex[dev,consul,iterm2]"
 ```
 
 ## Development

{sshplex-1.6.1 → sshplex-1.6.3}/README.md

@@ -8,12 +8,20 @@ SSHplex is a Python-based SSH connection multiplexer with a modern TUI. Connect
 
 - 🖥️ **Modern TUI** - Textual-based host selector with search, sort, and multi-select
 - 🔌 **Multiple Sources** - NetBox, Ansible, Consul, static lists - use them together
-- 📦 **3 Backends** - tmux standalone, tmux + iTerm2, or iTerm2 native (macOS)
-- ✏️ **Config Editor** - Built-in YAML editor with validation (`e` key)
+- 📦 **3 Mux Backends** - tmux standalone, tmux + iTerm2, or iTerm2 native (macOS)
+- ✏️ **Config Editor** - Built-in editor with compact source cards, static host rows, and full YAML pane
 - 🔄 **Broadcast Input** - Sync commands across multiple SSH sessions
 - 🔐 **SSH Security** - Configurable host key checking and retry logic
 - 🚀 **Fast Startup** - Intelligent caching with configurable TTL
 
+## What Is New in QoL v2
+
+- **Static host manager in UI** - Add and edit static hosts as rows (`name`, `ip`, `alias`, `user`, `port`, `key_path`) instead of raw YAML blobs.
+- **Per-host SSH preview** - Preview effective SSH values from `ssh -G` in settings and from host selector (`o`).
+- **Smarter table columns** - Detect columns from live hosts/cache/imports, including SSH-oriented fields like `alias`, `user`, `port`, and `key_path`.
+- **Better Sources UX** - Provider toggles and collapsible import cards make large source configs easier to navigate.
+- **Rich YAML view** - Side-by-side YAML edit + syntax-highlight preview for full config inspection.
+
 ## Quick Start
 
 ```bash
@@ -30,24 +38,9 @@ sshplex
 ### Prerequisites
 
 - Python 3.8+
-- tmux (Linux/macOS) or iTerm2 (macOS)
+- tmux (Linux/macOS) and/or iTerm2 (macOS)
 - SSH key configured for target hosts
 
-## Usage
-
-| Key | Action |
-|-----|--------|
-| `Space` | Toggle host selection |
-| `a` / `d` | Select / Deselect all |
-| `Enter` | Connect to selected hosts |
-| `/` | Search/filter hosts |
-| `p` | Toggle panes/tabs mode |
-| `b` | Toggle broadcast mode |
-| `e` | Open config editor |
-| `s` | Open session manager |
-| `h` | Show keyboard shortcuts |
-| `q` | Quit |
-
 ## Multiplexer Backends
 
 | Backend | Platform | Best For |
@@ -56,58 +49,17 @@ sshplex
 | **tmux + iTerm2** | macOS | Native UI + persistence |
 | **iTerm2 native** | macOS | Simple setup, no tmux dependency |
 
-```yaml
-# ~/.config/sshplex/sshplex.yaml
-tmux:
-  backend: "tmux"  # or "iterm2-native" on macOS
-  layout: "tiled"
-  max_panes_per_window: 5
-```
-
 ## Sources of Truth
 
-### Static Hosts
-```yaml
-sot:
-  import:
-    - name: "my-servers"
-      type: static
-      hosts:
-        - {name: "web-01", ip: "192.168.1.10", tags: ["web"]}
-```
+| Provider | `type` | Extra Dependency | Best For |
+|----------|--------|------------------|----------|
+| **Static** | `static` | None | Small lists, lab hosts, quick manual entries |
+| **NetBox** | `netbox` | None (included in base install) | Inventory-driven infrastructure with metadata |
+| **Ansible** | `ansible` | None | Reusing existing Ansible inventory files |
+| **Consul** | `consul` | `pip install "sshplex[consul]"` | Service discovery and dynamic node catalogs |
 
-### NetBox
-```yaml
-sot:
-  import:
-    - name: "prod"
-      type: netbox
-      url: "https://netbox.example.com/"
-      token: "your-api-token"
-```
+Provider activation is controlled by `sot.providers`, and each source is configured as an item in `sot.import`.
 
-### Ansible
-```yaml
-sot:
-  import:
-    - name: "inventory"
-      type: ansible
-      inventory_paths: ["/path/to/inventory.yml"]
-```
-
-### Consul
-```bash
-pip install "sshplex[consul]"
-```
-```yaml
-sot:
-  import:
-    - name: "dc1"
-      type: consul
-      config:
-        host: "consul.example.com"
-        token: "your-token"
-```
 
 ## Local Demo (Consul + Ansible)
 
@@ -126,45 +78,12 @@ Demo files:
 - `demo/docker-compose.consul-demo.yml`
 - `demo/sshplex.demo.yaml`
 
-Example config snippet:
-
-```yaml
-sot:
-  providers: ["ansible", "consul"]
-  import:
-    - name: "demo-ansible"
-      type: ansible
-      inventory_paths:
-        - "demo/ansible-inventory-demo.yml"
-
-    - name: "demo-consul"
-      type: consul
-      config:
-        host: "127.0.0.1"
-        port: 8500
-        token: ""
-        scheme: "http"
-        verify: false
-        dc: "dc1"
-```
-
 Run with the bundled demo config:
 
 ```bash
 sshplex --config demo/sshplex.demo.yaml
 ```
 
-## CLI Reference
-
-```bash
-sshplex                        # Launch TUI
-sshplex --onboarding           # Interactive setup wizard
-sshplex --debug                # Test provider connectivity
-sshplex --show-config          # Show config paths
-sshplex --clear-cache          # Clear host cache
-sshplex --config /path/to.yml  # Use custom config
-```
-
 ## Documentation
 
 | Guide | Description |
@@ -179,14 +98,8 @@ sshplex --config /path/to.yml  # Use custom config
 # Basic (tmux only)
 pip install sshplex
 
-# With Consul support
-pip install "sshplex[consul]"
-
-# With iTerm2 native support (macOS)
-pip install "sshplex[iterm2]"
-
-# Development
-pip install -e ".[dev]"
+# With Consul,DEV,Iterm2 support
+pip install "sshplex[dev,consul,iterm2]"
 ```
 
 ## Development

{sshplex-1.6.1 → sshplex-1.6.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "sshplex"
-version = "1.6.1"
+version = "1.6.3"
 description = "Multiplex your SSH connections with style"
 authors = [{name = "MJAHED Sabri", email = "contact@sabrimjahed.com"}]
 readme = "README.md"
@@ -113,6 +113,11 @@ module = ["consul"]
 ignore_missing_imports = true
 
 
+[[tool.mypy.overrides]]
+module = ["pynetbox", "pynetbox.*", "pyperclip", "pyperclip.*"]
+ignore_missing_imports = true
+
+
 [[tool.mypy.overrides]]
 module = ["sshplex.lib.sot.consul"]
 ignore_errors = true

{sshplex-1.6.1 → sshplex-1.6.3}/sshplex/__init__.py

@@ -1,4 +1,4 @@
 """SSHplex - SSH Connection Multiplexer"""
-__version__ = "1.6.1"
+__version__ = "1.6.3"
 __author__ = "MJAHED Sabri"
 __email__ = "contact@sabrimjahed.com"

{sshplex-1.6.1 → sshplex-1.6.3}/sshplex/cli.py

@@ -5,9 +5,9 @@ import sys
 from typing import Any
 
 from . import __version__
-from .lib.config import get_config_info, load_config
+from .lib.commands import clear_cache, run_debug_mode, show_config_info
+from .lib.config import load_config
 from .lib.logger import get_logger, setup_logging
-from .lib.sot.factory import SoTFactory
 
 
 def main() -> int:
@@ -62,11 +62,15 @@ Examples:
             logger.info("SSHplex CLI started")
 
             if args.clear_cache:
-                return clear_cache(config, logger)
+                return clear_cache(config, logger, no_cache_message="Clearing cache...")
             elif args.list_providers:
                 return list_providers(config, logger)
             else:
-                return debug_mode(config, logger)
+                return run_debug_mode(
+                    config,
+                    logger,
+                    footer_note="Note: For the full TUI interface, run the main application",
+                )
         else:
             # Default to debug mode if no specific action
             print("SSHplex CLI - Loading configuration...")
@@ -81,7 +85,11 @@ Examples:
             logger = get_logger()
             logger.info("SSHplex CLI debug mode started")
 
-            return debug_mode(config, logger)
+            return run_debug_mode(
+                config,
+                logger,
+                footer_note="Note: For the full TUI interface, run the main application",
+            )
 
     except FileNotFoundError as e:
         print(f"Error: {e}")
@@ -99,25 +107,6 @@ Examples:
         return 1
 
 
-def show_config_info() -> int:
-    """Show configuration file paths and status."""
-    info = get_config_info()
-    
-    print("📁 SSHplex Configuration Information")
-    print("=" * 50)
-    print(f"Config Directory:    {info['default_config_path'].rsplit('/', 1)[0]}")
-    print(f"Config File:         {info['default_config_path']}")
-    print(f"Config Exists:       {'✅ Yes' if info['default_config_exists'] else '❌ No'}")
-    print(f"Template File:       {info['template_path']}")
-    print(f"Template Exists:     {'✅ Yes' if info['template_exists'] else '❌ No'}")
-    print()
-    
-    if not info['default_config_exists']:
-        print("💡 Run 'sshplex' to create a default configuration file")
-    
-    return 0
-
-
 def list_providers(config: Any, logger: Any) -> int:
     """List all configured SoT providers."""
     logger.info("Listing configured SoT providers")
@@ -156,88 +145,5 @@ def list_providers(config: Any, logger: Any) -> int:
     return 0
 
 
-def clear_cache(config: Any, logger: Any) -> int:
-    """Clear the host cache."""
-    logger.info("Clearing host cache")
-    
-    from .lib.cache import HostCache
-    
-    cache = HostCache(
-        cache_dir=config.cache.cache_dir,
-        cache_ttl_hours=config.cache.ttl_hours
-    )
-    
-    cache_info = cache.get_cache_info()
-    if cache_info:
-        print(f"🗑️  Clearing cache ({cache_info.get('host_count', 0)} hosts, age: {cache_info.get('age_hours', 0):.1f}h)")
-    else:
-        print("🗑️  Clearing cache...")
-    
-    if cache.clear_cache():
-        print("✅ Cache cleared successfully")
-        return 0
-    else:
-        print("❌ Failed to clear cache")
-        return 1
-
-
-def debug_mode(config: Any, logger: Any) -> int:
-    """Run debug mode - SoT provider connection and host listing test."""
-    logger.info("Running CLI debug mode - SoT provider connectivity test")
-
-    # Initialize SoT factory
-    logger.info("Initializing SoT factory")
-    sot_factory = SoTFactory(config)
-
-    # Check cache status
-    cache_info = sot_factory.get_cache_info()
-    if cache_info:
-        print(f"📦 Cache: {cache_info.get('host_count', 0)} hosts cached ({cache_info.get('age_hours', 0):.1f}h old)")
-
-    # Initialize all providers
-    if not sot_factory.initialize_providers():
-        logger.error("Failed to initialize any SoT providers")
-        print("❌ Failed to initialize any SoT providers")
-        print("Check your configuration and network connectivity")
-        return 1
-
-    print(f"✅ Successfully initialized {sot_factory.get_provider_count()} SoT provider(s): {', '.join(sot_factory.get_provider_names())}")
-
-    # Test all connections
-    logger.info("Testing SoT provider connections...")
-    connection_results = sot_factory.test_all_connections()
-
-    for provider_name, status in connection_results.items():
-        if status:
-            print(f"✅ {provider_name}: Connection successful")
-        else:
-            print(f"❌ {provider_name}: Connection failed")
-
-    # Retrieve hosts from all providers
-    logger.info("Retrieving hosts from all SoT providers...")
-    hosts = sot_factory.get_all_hosts()
-
-    # Display results
-    if hosts:
-        logger.info(f"Successfully retrieved {len(hosts)} hosts")
-        print(f"\n📋 Found {len(hosts)} hosts from all providers:")
-        print("-" * 80)
-        for i, host in enumerate(hosts, 1):
-            status = getattr(host, 'status', host.metadata.get('status', 'unknown'))
-            sources = host.metadata.get('sources', ['unknown'])
-            source_str = ', '.join(sources) if isinstance(sources, list) else str(sources)
-            print(f"{i:3d}. {host.name:<25} {host.ip:<15} [{status:<8}] ({source_str})")
-        print("-" * 80)
-    else:
-        logger.warning("No hosts found matching the filters")
-        print("⚠️  No hosts found matching the configured filters")
-        print("Check your SoT provider filters in the configuration")
-
-    logger.info("SSHplex CLI debug mode completed successfully")
-    print("\n✅ CLI debug mode completed successfully")
-    print("Note: For the full TUI interface, run the main application")
-    return 0
-
-
 if __name__ == "__main__":
     sys.exit(main())

{sshplex-1.6.1 → sshplex-1.6.3}/sshplex/config-template.yaml

@@ -109,6 +109,7 @@ tmux:
   iterm2_profile: "Default" # iTerm2 profile name to use
 
 ui:
+  theme: "textual-dark"
   show_log_panel: false
   log_panel_height: 20
   table_columns: ["name", "ip", "cluster", "tags", "description", "provider"]

{sshplex-1.6.1 → sshplex-1.6.3}/sshplex/lib/cache.py

@@ -22,13 +22,13 @@ class HostCache:
         """Initialize the cache manager.
 
         Args:
-            cache_dir: Directory to store cache files (defaults to ~/cache/sshplex)
+            cache_dir: Directory to store cache files (defaults to ~/.cache/sshplex)
             cache_ttl_hours: Cache time-to-live in hours (default 24 hours)
         """
         self.logger = get_logger()
 
         if cache_dir is None:
-            cache_dir = os.path.expanduser("~/cache/sshplex")
+            cache_dir = os.path.expanduser("~/.cache/sshplex")
 
         self.cache_dir = Path(cache_dir)
         self.cache_ttl = timedelta(hours=cache_ttl_hours)

sshplex-1.6.3/sshplex/lib/commands.py

@@ -0,0 +1,110 @@
+"""Shared command helpers for main and CLI entry points."""
+
+from __future__ import annotations
+
+from typing import Any
+
+from .cache import HostCache
+from .config import get_config_info
+from .sot.factory import SoTFactory
+
+
+def show_config_info() -> int:
+    """Show configuration file paths and status."""
+    info = get_config_info()
+
+    print("📁 SSHplex Configuration Information")
+    print("=" * 50)
+    print(f"Config Directory:    {info['default_config_path'].rsplit('/', 1)[0]}")
+    print(f"Config File:         {info['default_config_path']}")
+    print(f"Config Exists:       {'✅ Yes' if info['default_config_exists'] else '❌ No'}")
+    print(f"Template File:       {info['template_path']}")
+    print(f"Template Exists:     {'✅ Yes' if info['template_exists'] else '❌ No'}")
+    print()
+
+    if not info['default_config_exists']:
+        print("💡 Run 'sshplex' to create a default configuration file")
+
+    return 0
+
+
+def clear_cache(config: Any, logger: Any, no_cache_message: str = "No cache to clear") -> int:
+    """Clear the host cache."""
+    logger.info("Clearing host cache")
+
+    cache = HostCache(
+        cache_dir=config.cache.cache_dir,
+        cache_ttl_hours=config.cache.ttl_hours,
+    )
+
+    cache_info = cache.get_cache_info()
+    if cache_info:
+        print(
+            "🗑️  Clearing cache "
+            f"({cache_info.get('host_count', 0)} hosts, age: {cache_info.get('age_hours', 0):.1f}h)"
+        )
+    else:
+        print(f"🗑️  {no_cache_message}")
+        return 0
+
+    if cache.clear_cache():
+        print("✅ Cache cleared successfully")
+        return 0
+
+    print("❌ Failed to clear cache")
+    return 1
+
+
+def run_debug_mode(config: Any, logger: Any, footer_note: str = "") -> int:
+    """Run provider connectivity + host retrieval debug flow."""
+    logger.info("Running debug mode - SoT provider connectivity test")
+
+    sot_factory = SoTFactory(config)
+
+    cache_info = sot_factory.get_cache_info()
+    if cache_info:
+        print(f"📦 Cache: {cache_info.get('host_count', 0)} hosts cached ({cache_info.get('age_hours', 0):.1f}h old)")
+
+    if not sot_factory.initialize_providers():
+        logger.error("Failed to initialize any SoT providers")
+        print("❌ Failed to initialize any SoT providers")
+        print("Check your configuration and network connectivity")
+        return 1
+
+    print(
+        "✅ Successfully initialized "
+        f"{sot_factory.get_provider_count()} SoT provider(s): {', '.join(sot_factory.get_provider_names())}"
+    )
+
+    logger.info("Testing SoT provider connections...")
+    connection_results = sot_factory.test_all_connections()
+
+    for provider_name, status in connection_results.items():
+        if status:
+            print(f"✅ {provider_name}: Connection successful")
+        else:
+            print(f"❌ {provider_name}: Connection failed")
+
+    logger.info("Retrieving hosts from all SoT providers...")
+    hosts = sot_factory.get_all_hosts()
+
+    if hosts:
+        logger.info(f"Successfully retrieved {len(hosts)} hosts")
+        print(f"\n📋 Found {len(hosts)} hosts from all providers:")
+        print("-" * 80)
+        for i, host in enumerate(hosts, 1):
+            status = getattr(host, 'status', host.metadata.get('status', 'unknown'))
+            sources = host.metadata.get('sources', ['unknown'])
+            source_str = ', '.join(sources) if isinstance(sources, list) else str(sources)
+            print(f"{i:3d}. {host.name:<25} {host.ip:<15} [{status:<8}] ({source_str})")
+        print("-" * 80)
+    else:
+        logger.warning("No hosts found matching the filters")
+        print("⚠️  No hosts found matching the configured filters")
+        print("Check your SoT provider filters in the configuration")
+
+    logger.info("SSHplex debug mode completed successfully")
+    print("\n✅ Debug mode completed successfully")
+    if footer_note:
+        print(footer_note)
+    return 0