An ESM-first Node.js SSH client with host-key checks, long-lived connections, command execution, interactive shells, and SFTP transfers.
- Features
- Requirements
- Setup
- Usage
- Development
- Testing
- Troubleshooting
- Security
- API
- Packaging
- Examples
- Support
- Links
- License
Run SSH commands, open shells, copy files, and verify host keys through Node.js.
Use Node.js 26 or later with native ESM. Configure trusted host data and an authentication method for each SSH server.
Run npm install @eliware/ssh-client in your project.
Read the installation guide before you connect.
Import sshExec to run commands.
Read the user guide for connection, command, shell, file copy, and host verification details.
Read RELEASE_NOTES.md for release history.
Read the specifications index for repository requirements.
Run npm test for aggregate validation.
Read the troubleshooting guide when an operation fails.
Read the host verification guide before you configure host trust or authentication.
The package exports its public API from src/public-api.mjs and its declarations from src/public-api.d.ts.
Read the API guide for exported functions and options.
The package includes src/, docs/, README.md, AGENTS.md, LICENSE, RELEASE_NOTES.md, examples/, and specs/.
Use a numeric MAJOR.MINOR.PATCH version and a matching v<version> tag.
The npm workflow validates the tagged version, runs npm test, and publishes with provenance.
Follow Eliware Operations procedures for release authorization.
Run node examples/example.mjs from the repository root.
Read examples/README.md for example requirements.
For help, questions, or to chat with the author and community, visit:
