sshplex 1.4.0__tar.gz → 1.6.0__tar.gz

sshplex-1.6.0/PKG-INFO

@@ -0,0 +1,225 @@
+Metadata-Version: 2.4
+Name: sshplex
+Version: 1.6.0
+Summary: Multiplex your SSH connections with style
+Author-email: MJAHED Sabri <contact@sabrimjahed.com>
+License: MIT
+Project-URL: Homepage, https://github.com/sabrimjd/sshplex
+Project-URL: Repository, https://github.com/sabrimjd/sshplex
+Project-URL: Documentation, https://github.com/sabrimjd/sshplex#readme
+Project-URL: Bug Tracker, https://github.com/sabrimjd/sshplex/issues
+Keywords: ssh,tmux,multiplexer,netbox,tui,terminal
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: MacOS
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: System :: Networking
+Classifier: Topic :: System :: Systems Administration
+Classifier: Topic :: Terminals
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pynetbox==7.6.1
+Requires-Dist: textual==8.0.0
+Requires-Dist: pyyaml==6.0.3
+Requires-Dist: pydantic==2.12.5
+Requires-Dist: loguru==0.7.3
+Requires-Dist: rich==14.3.2
+Requires-Dist: libtmux==0.53.1
+Requires-Dist: pyperclip==1.11.0
+Provides-Extra: consul
+Requires-Dist: python-consul2>=0.1.5; extra == "consul"
+Provides-Extra: iterm2
+Requires-Dist: iterm2>=2.0.0; extra == "iterm2"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: black>=22.0.0; extra == "dev"
+Requires-Dist: flake8>=5.0.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Requires-Dist: ruff>=0.8.0; extra == "dev"
+Requires-Dist: vulture>=2.11; extra == "dev"
+Requires-Dist: types-PyYAML>=6.0.0; extra == "dev"
+Dynamic: license-file
+
+![SSHPlex Demo](demo/demo.gif)
+
+**Multiplex your SSH connections with style**
+
+SSHplex is a Python-based SSH connection multiplexer with a modern TUI. Connect to multiple hosts simultaneously using tmux or iTerm2, with sources from NetBox, Ansible, Consul, or static lists.
+
+## Features
+
+- 🖥️ **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)
+- 🔄 **Broadcast Input** - Sync commands across multiple SSH sessions
+- 🔐 **SSH Security** - Configurable host key checking and retry logic
+- 🚀 **Fast Startup** - Intelligent caching with configurable TTL
+
+## Quick Start
+
+```bash
+# Install
+pip install sshplex
+
+# First-time setup (interactive wizard)
+sshplex --onboarding
+
+# Launch TUI
+sshplex
+```
+
+### Prerequisites
+
+- Python 3.8+
+- tmux (Linux/macOS) 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 |
+|---------|----------|----------|
+| **tmux** | Linux, macOS | Maximum compatibility, persistence |
+| **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"]}
+```
+
+### NetBox
+```yaml
+sot:
+  import:
+    - name: "prod"
+      type: netbox
+      url: "https://netbox.example.com/"
+      token: "your-api-token"
+```
+
+### 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"
+```
+
+## 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 |
+|-------|-------------|
+| [Configuration](docs/configuration.md) | Full config reference with examples |
+| [Backends](docs/backends.md) | Multiplexer backend options and setup |
+| [Troubleshooting](docs/troubleshooting.md) | Common issues and solutions |
+
+## Installation Options
+
+```bash
+# 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]"
+```
+
+## Development
+
+```bash
+git clone https://github.com/sabrimjd/sshplex.git
+cd sshplex
+pip install -e ".[dev]"
+
+# Run tests
+pytest tests/ -v
+
+# Quality checks
+ruff check sshplex tests
+mypy sshplex
+```
+
+## License
+
+MIT License - see [LICENSE](LICENSE) for details.
+
+## Author
+
+**Sabrimjd** - [@sabrimjd](https://github.com/sabrimjd)
+
+---
+
+**SSHplex** - Because managing multiple SSH connections should be simple.

sshplex-1.6.0/README.md

@@ -0,0 +1,172 @@
+![SSHPlex Demo](demo/demo.gif)
+
+**Multiplex your SSH connections with style**
+
+SSHplex is a Python-based SSH connection multiplexer with a modern TUI. Connect to multiple hosts simultaneously using tmux or iTerm2, with sources from NetBox, Ansible, Consul, or static lists.
+
+## Features
+
+- 🖥️ **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)
+- 🔄 **Broadcast Input** - Sync commands across multiple SSH sessions
+- 🔐 **SSH Security** - Configurable host key checking and retry logic
+- 🚀 **Fast Startup** - Intelligent caching with configurable TTL
+
+## Quick Start
+
+```bash
+# Install
+pip install sshplex
+
+# First-time setup (interactive wizard)
+sshplex --onboarding
+
+# Launch TUI
+sshplex
+```
+
+### Prerequisites
+
+- Python 3.8+
+- tmux (Linux/macOS) 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 |
+|---------|----------|----------|
+| **tmux** | Linux, macOS | Maximum compatibility, persistence |
+| **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"]}
+```
+
+### NetBox
+```yaml
+sot:
+  import:
+    - name: "prod"
+      type: netbox
+      url: "https://netbox.example.com/"
+      token: "your-api-token"
+```
+
+### 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"
+```
+
+## 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 |
+|-------|-------------|
+| [Configuration](docs/configuration.md) | Full config reference with examples |
+| [Backends](docs/backends.md) | Multiplexer backend options and setup |
+| [Troubleshooting](docs/troubleshooting.md) | Common issues and solutions |
+
+## Installation Options
+
+```bash
+# 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]"
+```
+
+## Development
+
+```bash
+git clone https://github.com/sabrimjd/sshplex.git
+cd sshplex
+pip install -e ".[dev]"
+
+# Run tests
+pytest tests/ -v
+
+# Quality checks
+ruff check sshplex tests
+mypy sshplex
+```
+
+## License
+
+MIT License - see [LICENSE](LICENSE) for details.
+
+## Author
+
+**Sabrimjd** - [@sabrimjd](https://github.com/sabrimjd)
+
+---
+
+**SSHplex** - Because managing multiple SSH connections should be simple.

{sshplex-1.4.0 → sshplex-1.6.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "sshplex"
-version = "1.4.0"
+version = "1.6.0"
 description = "Multiplex your SSH connections with style"
 authors = [{name = "MJAHED Sabri", email = "contact@sabrimjahed.com"}]
 readme = "README.md"
@@ -44,6 +44,9 @@ dependencies = [
 consul = [
     "python-consul2>=0.1.5",
 ]
+iterm2 = [
+    "iterm2>=2.0.0",
+]
 dev = [
     "pytest>=7.0.0",
     "pytest-cov>=4.0.0",

{sshplex-1.4.0 → sshplex-1.6.0}/sshplex/__init__.py

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

{sshplex-1.4.0 → sshplex-1.6.0}/sshplex/config-template.yaml

@@ -95,11 +95,18 @@ ssh:
       key_path: "~/.ssh/id_rsa"
 
 tmux:
+  backend: "tmux" # tmux, iterm2-native
+  iterm2_native_target: "current-window" # current-window, new-window (iterm2-native only)
+  iterm2_native_hide_from_history: true # prefix with leading space when dispatching (iterm2-native)
+  use_panes: true # true = panes, false = tabs
   layout: "tiled" # tiled, even-horizontal, even-vertical
   broadcast: false # Start with broadcast off
   window_name: "sshplex"
   max_panes_per_window: 5 # Maximum panes per window before creating a new window
-  control_with_iterm2: false # Use iTerm2 tmux integration (macOS only)
+  # iTerm2 integration (macOS only)
+  control_with_iterm2: false # Use iTerm2 tmux -CC mode (macOS only)
+  iterm2_attach_target: "new-window" # Where to open tmux session: new-window, new-tab
+  iterm2_profile: "Default" # iTerm2 profile name to use
 
 ui:
   show_log_panel: false

{sshplex-1.4.0 → sshplex-1.6.0}/sshplex/lib/config.py

@@ -69,12 +69,80 @@ class SSHConfig(BaseModel):
     proxy: List[Proxy] = Field(alias='proxy', default_factory=list, description="List of proxies")
 
 class TmuxConfig(BaseModel):
-    """tmux configuration."""
+    """tmux/iTerm2 multiplexer configuration.
+
+    Three backend options:
+    1. tmux standalone: backend="tmux", control_with_iterm2=false
+    2. tmux + iTerm2: backend="tmux", control_with_iterm2=true (macOS only)
+    3. iTerm2 native: backend="iterm2-native" (macOS only)
+    """
+    # Backend selection
+    backend: str = Field(
+        default="tmux",
+        description="Multiplexer backend: 'tmux' or 'iterm2-native'"
+    )
+    # Common options
+    use_panes: bool = Field(default=True, description="Connection mode: true=panes, false=tabs")
     layout: str = "tiled"  # tiled, even-horizontal, even-vertical
     broadcast: bool = False  # Start with broadcast off
     window_name: str = "sshplex"
     max_panes_per_window: int = Field(default=5, description="Maximum panes per window before creating a new window")
-    control_with_iterm2: bool = False  # Use iTerm2 tmux integration on macOS
+    # iTerm2 + tmux integration (macOS only, for backend="tmux")
+    control_with_iterm2: bool = Field(default=False, description="Use iTerm2 tmux -CC mode (macOS only)")
+    iterm2_attach_target: str = Field(
+        default="new-window",
+        description="Where to open tmux session in iTerm2: new-window or new-tab"
+    )
+    # iTerm2 native specific (macOS only, for backend="iterm2-native")
+    iterm2_profile: str = Field(default="Default", description="iTerm2 profile to use for new windows/tabs")
+    iterm2_native_target: str = Field(
+        default="current-window",
+        description="Where to open iTerm2 native sessions: current-window or new-window"
+    )
+    iterm2_native_hide_from_history: bool = Field(
+        default=True,
+        description="Prefix native iTerm2 dispatched commands with a leading space"
+    )
+    iterm2_split_pattern: str = Field(
+        default="alternate",
+        description="Split pattern for iTerm2 native: alternate, vertical, horizontal"
+    )
+
+    def validate_backend_config(self) -> bool:
+        """Validate backend configuration.
+
+        Returns:
+            True if config is valid, raises ValueError otherwise
+        """
+        import platform
+
+        # Validate backend option
+        valid_backends = ["tmux", "iterm2-native"]
+        if self.backend not in valid_backends:
+            raise ValueError(
+                f"Invalid backend: {self.backend}. Must be one of: {valid_backends}"
+            )
+
+        # Validate iTerm2 native mode on macOS only
+        if self.backend == "iterm2-native" and platform.system().lower() != "darwin":
+            raise ValueError(
+                "backend: 'iterm2-native' is only supported on macOS. "
+                "Use backend: 'tmux' on Linux/other systems."
+            )
+
+        if self.iterm2_native_target not in ["current-window", "new-window"]:
+            raise ValueError(
+                "tmux.iterm2_native_target must be one of: ['current-window', 'new-window']"
+            )
+
+        # Validate control_with_iterm2 on macOS only
+        if self.control_with_iterm2 and platform.system().lower() != "darwin":
+            raise ValueError(
+                "tmux.control_with_iterm2 is only supported on macOS. "
+                "Set this to false on Linux/other systems."
+            )
+
+        return True
 
 
 class AnsibleConfig(BaseModel):
@@ -88,7 +156,7 @@ class ConsulConfig(BaseModel):
     port: int = Field(443, description="Consul port number")
     token: str = Field("default_token", description="Consul token for authentication")
     scheme: str = Field("https", description="URL scheme (e.g., 'https')")
-    verify: bool = Field(False, description="Whether to verify SSL certificates")
+    verify: bool = Field(True, description="Whether to verify SSL certificates (default: True for security)")
     dc: str = Field("dc1", description="Datacenter name")
     cert: str = Field("", description="Path to SSL certificate")