ssh-x-term 0.0.29

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Eugen Iofciu Vasile
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,219 @@
+# SSH-X-Term
+
+SSH-X-Term is a powerful terminal-based SSH client with a TUI (Text User Interface) built on [Bubble Tea](https://github.com/charmbracelet/bubbletea).  
+It lets you manage SSH connections, securely store credentials using Bitwarden, and connect to remote servers with both password and key-based authentication.  
+Cross-platform features include support for passh (Unix), plink.exe (Windows), and full tmux integration.
+
+![Screenshot](https://github.com/user-attachments/assets/a545d09b-2101-4c6d-b5b9-377b2d554d57)
+
+## Features
+
+- Manage SSH connections in an interactive Bubble Tea TUI.
+- Secure credential storage and retrieval via Bitwarden CLI.
+- Password-based SSH login automation using passh (Unix) or plink.exe (Windows).
+- Key-based SSH authentication.
+- Open connections in new tmux windows or current terminal.
+- Fullscreen and responsive TUI.
+
+## Project Structure
+
+```
+ssh-x-term/
+├── cmd/
+│   └── sxt/
+│       └── main.go                        # Application entry point
+├── internal/
+│   ├── config/
+│   │   ├── config.go                      # Configuration handling
+│   │   └── models.go                      # Configuration data models
+│   ├── ssh/
+│   │   ├── client.go                      # SSH client implementation
+│   │   ├── session_unix.go                # SSH session management (Unix)
+│   │   └── session_windows.go             # SSH session management (Windows)
+│   └── ui/
+│       ├── components/
+│       │   ├── bitwarden_config.go        # Bitwarden CLI configuration form/component
+│       │   ├── bitwarden_login_form.go    # Bitwarden login form component
+│       │   ├── bitwarden_unlock_form.go   # Bitwarden unlock form component
+│       │   ├── connection_list.go         # List of SSH connections
+│       │   ├── form.go                    # Form for adding/editing connections
+│       │   ├── storage_select.go          # Credential storage selection (Bitwarden/etc.)
+│       │   └── terminal.go                # Terminal component for SSH sessions
+│       ├── model.go                       # Main UI model
+│       ├── update.go                      # Update logic for UI
+│       └── view.go                        # View rendering logic
+├── pkg/
+│   └── sshutil/
+│       ├── auth.go                        # Authentication utilities (passh/plink, etc.)
+│       ├── terminal_unix.go               # Terminal utilities (Unix)
+│       └── terminal_windows.go            # Terminal utilities (Windows)
+├── go.mod
+├── go.sum
+└── README.md
+```
+
+**Note:**  
+- Bitwarden integration is handled via several UI components:  
+  - `bitwarden_config.go`, `bitwarden_login_form.go`, `bitwarden_unlock_form.go` for configuration, login, and unlock flows.  
+  - `storage_select.go` lets users choose Bitwarden or other credential storage.
+ 
+**Flow chart**
+- [FLOW](https://github.com/eugeniofciuvasile/ssh-x-term/blob/main/FLOW.md)
+
+## Prerequisites
+
+- **Go 1.24+**
+- **Bitwarden CLI (`bw`)** — for credential management ([install guide](https://bitwarden.com/help/cli/))
+- **passh** — for password authentication on Unix ([compile it from here](https://github.com/clarkwang/passh))
+- **tmux** — recommended for multi-window SSH sessions ([install guide](https://github.com/tmux/tmux/wiki/Installing))
+- **plink.exe** — for password authentication on Windows ([download from PuTTY](https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html))
+- **(Optional) ssh client** — `ssh` should be available on your system
+
+**Ensure all required binaries are available in your `$PATH`.**
+
+## System dependencies
+
+ssh-x-term requires the following system tools to be installed:
+
+- `tmux`
+- `passh`
+- `bitwarden-cli` (npm package: `@bitwarden/cli`, install globally: `npm install -g @bitwarden/cli`)
+
+### Linux (Debian/Ubuntu):
+
+```sh
+sudo apt update
+sudo apt install -y tmux
+npm install -g @bitwarden/cli
+# follow github repo https://github.com/clarkwang/passh to compile passh
+```
+
+### macOS (with Homebrew):
+
+```sh
+brew install tmux
+npm install -g @bitwarden/cli
+# follow github repo https://github.com/clarkwang/passh to compile passh
+```
+
+### Windows:
+
+- Install `tmux` and `passh` via WSL/Cygwin or use alternatives.
+- Install Bitwarden CLI with: `npm install -g @bitwarden/cli`
+
+## Installation
+
+### Option 1: Install using npm (Recommended)
+
+The easiest way to install SSH-X-Term is using npm:
+
+```sh
+# Install globally
+npm install -g ssh-x-term
+
+# Run the command
+sxt
+```
+
+This will automatically download the appropriate binary for your platform and set up the command.
+
+The npm installer also attempts to install required dependencies (`bw`, `passh`, `tmux`) if they are not already available in your system's `$PATH`.
+
+---
+
+### Option 2: Build from source
+
+Ensure you have **Go 1.21+** installed. You can use either the Go from your package manager or [install manually](https://go.dev/dl/).  
+If you manually install Go, add the following to your shell config (`~/.bashrc`, `~/.zshrc`, etc.):
+
+```sh
+export GOROOT=/usr/local/go
+export GOPATH=$HOME/go
+export PATH=$GOPATH/bin:$GOROOT/bin:$PATH
+```
+
+Then:
+
+```sh
+# Clone and build the project
+git clone https://github.com/eugeniofciuvasile/ssh-x-term.git
+cd ssh-x-term
+go build -o sxt ./cmd/sxt
+```
+
+Or install globally with Go:
+
+```sh
+go install github.com/eugeniofciuvasile/ssh-x-term/cmd/sxt@latest
+```
+
+Make sure `$GOPATH/bin` is in your `$PATH` to use `sxt` from anywhere.
+
+---
+
+### Option 3: Download pre-built binary
+
+You can download the pre-built binary for your platform from the [Releases](https://github.com/eugeniofciuvasile/ssh-x-term/releases) page.
+
+After downloading:
+
+```sh
+chmod +x sxt
+mv sxt /usr/local/bin/   # or any location in your PATH
+```
+
+## Usage
+1. Run the app:
+```sh
+./sxt
+# or, if installed globally:
+sxt
+```
+    
+2. **Manage SSH connections:**
+    - Press `a` to add, `e` to edit, `d` to delete a connection.
+    - Press `o` to toggle opening connections in a new tmux window.
+    - Press `Enter` to connect.
+    - Use arrow keys to navigate.
+    - All credentials are stored/retrieved using Bitwarden.
+
+3. **Connection Form:**
+    - Fill in fields as prompted.
+    - `Tab` to navigate, `Ctrl+p` to toggle auth type, `Enter` to submit, `Esc` to cancel.
+
+4. **SSH Session:**
+    - `Esc` to disconnect.
+    - Passwords are supplied securely via passh or plink.exe (never echoed or stored in plaintext).
+
+## Configuration
+
+Config is stored at: `~/.config/ssh-x-term/ssh-x-term.json`  
+Connection secrets are stored in your Bitwarden vault.
+
+## Security Notes
+
+- **Passwords are only handled via secure subprocesses (`passh`, `plink.exe`) and Bitwarden.**
+- **No plaintext passwords are ever written to disk or logs.**
+
+## License
+
+[MIT](LICENSE)
+
+## Disclaimer
+
+SSH-X-Term is an independent open-source project released under the MIT License.  
+It is **not affiliated with, endorsed by, or supported by** any of the credited projects, including Bubble Tea, Bitwarden, passh, PuTTY/plink, or any other third-party software listed above.
+
+**Security Notice:**  
+SSH-X-Term integrates with external tools for SSH and credential management.  
+The safe handling, storage, and security of your credentials (including passwords and keys) is ultimately your responsibility.  
+By using this software, you agree that the author and contributors bear **no liability** for any potential loss, compromise, or misuse of credentials or data.
+
+For details, see the [MIT License](LICENSE).
+
+## Credits
+
+- [Bubble Tea](https://github.com/charmbracelet/bubbletea)
+- [Bitwarden CLI](https://bitwarden.com/help/cli/)
+- [passh](https://github.com/clarkwang/passh)
+- [PuTTY/plink.exe](https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html)

package/index.js

@@ -0,0 +1,65 @@
+#!/usr/bin/env node
+
+const path = require('path');
+const os = require('os');
+const fs = require('fs');
+const { spawnSync } = require('child_process');
+
+// Platform and architecture
+const platform = os.platform();
+const arch = os.arch();
+const ext = platform === 'win32' ? '.exe' : '';
+
+// Map to GitHub release names
+const platformMap = {
+    darwin: 'darwin',
+    linux: 'linux',
+    win32: 'windows'
+};
+
+const archMap = {
+    x64: 'amd64',
+    arm64: 'arm64'
+};
+
+// Define download paths 
+const installDir = path.join(os.homedir(), '.ssh-x-term');
+const binName = `ssh-x-term-${platformMap[platform]}-${archMap[arch]}${ext}`;
+const binaryPath = path.join(installDir, binName);
+
+// Run the binary
+function runBinary() {
+    // Check if the binary exists
+    if (!fs.existsSync(binaryPath)) {
+        console.error(`Binary not found at ${binaryPath}`);
+        console.error('Please reinstall the package with: npm install -g ssh-x-term');
+        process.exit(1);
+    }
+
+    // Make sure it's executable
+    if (platform !== 'win32') {
+        try {
+            fs.chmodSync(binaryPath, '755');
+        } catch (err) {
+            console.error(`Error making binary executable: ${err.message}`);
+        }
+    }
+
+    // Run the binary with any passed arguments
+    const result = spawnSync(binaryPath, process.argv.slice(2), {
+        stdio: 'inherit'
+    });
+
+    // Forward the exit code
+    process.exit(result.status || 0);
+}
+
+// If this script is being executed directly, run the binary
+if (require.main === module) {
+    runBinary();
+}
+
+// Export for programmatic usage
+module.exports = {
+    run: runBinary
+};

package/install.js

@@ -0,0 +1,35 @@
+#!/usr/bin/env node
+
+const os = require('os');
+const { spawnSync } = require('child_process');
+
+const deps = [
+    { name: 'tmux', check: 'tmux' },
+    { name: 'passh', check: 'passh' },
+    { name: 'bw (bitwarden-cli)', check: 'bw' }
+];
+
+function checkDep(cmd) {
+    const which = os.platform() === 'win32' ? 'where' : 'which';
+    const res = spawnSync(which, [cmd]);
+    return res.status === 0;
+}
+
+function checkDeps() {
+    let missing = [];
+    deps.forEach(dep => {
+        if (!checkDep(dep.check)) {
+            missing.push(dep.name);
+        }
+    });
+
+    if (missing.length > 0) {
+        console.warn('\nMissing system dependencies:');
+        missing.forEach(dep => console.warn(`  - ${dep}`));
+        console.warn('\nPlease install these manually following the instructions in the README before using ssh-x-term.\n');
+    } else {
+        console.log('All system dependencies found.');
+    }
+}
+
+checkDeps();

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "ssh-x-term",
+  "version": "0.0.29",
+  "description": "TUI to handle multiple SSH connections simultaneously",
+  "main": "index.js",
+  "bin": {
+    "sxt": "index.js"
+  },
+  "scripts": {
+    "postinstall": "node install.js"
+  },
+  "files": [
+    "bin",
+    "install.js",
+    "index.js",
+    "README.md"
+  ],
+  "keywords": [
+    "ssh",
+    "terminal",
+    "golang",
+    "cli"
+  ],
+  "author": "Eugen Iofciu Vasile",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/eugeniofciuvasile/ssh-x-term.git"
+  },
+  "bugs": {
+    "url": "https://github.com/eugeniofciuvasile/ssh-x-term/issues"
+  },
+  "homepage": "https://github.com/eugeniofciuvasile/ssh-x-term#readme",
+  "os": [
+    "linux",
+    "darwin"
+  ],
+  "engines": {
+    "node": ">=14.0.0"
+  }
+}