@linely-io/cranky-ssh

SSH transport adapter and SshExecAction. This package owns the ssh2 dependency.

Requires Node.js 24+ for backend use and ES modules.

npm install @linely-io/cranky-ssh

import { createEngine } from '@linely-io/cranky-core';
import { sshConnectionAdapter } from '@linely-io/cranky-ssh';
const engine = createEngine(undefined, { adapters: { ssh: sshConnectionAdapter() } });
// Add named SSH connections, run ssh.exec, and await engine.close().

ssh.exec returns { stdout, stderr, code, signal, ok }. It accepts command, stdin, timeout (30,000 ms; 0 disables), maxBuffer (10 MiB combined output), failOnNonZero (false), and options containing env or pty. Supply ssh2 connect options directly; SSH config files, identity-file paths, jump hosts, and SFTP are not implemented. Supply key contents/agent credentials and host verification in connection config. Channels are independent; a timeout closes its channel without guaranteeing remote process termination.

See package composition and connections.