hivessh - npm Package Compare versions

Comparing version 1.1.5 to 1.1.6

dist/package-lock.json

 {
   "name": "hivessh",
-  "version": "1.1.7",
+  "version": "1.1.8",
   "lockfileVersion": 3,
@@ -9,3 +9,3 @@ "requires": true,
       "name": "hivessh",
-      "version": "1.1.7",
+      "version": "1.1.8",
       "license": "MIT",
@@ -23,5 +23,5 @@ "dependencies": {
     "node_modules/@types/node": {
-      "version": "20.17.11",
-      "resolved": "https://registry.npmjs.org/@types/node/-/node-20.17.11.tgz",
-      "integrity": "sha512-Ept5glCK35R8yeyIeYlRIZtX6SLRyqMhOFTgj5SOkMpLTdw3SEHI9fHx60xaUZ+V1aJxQJODE+7/j5ocZydYTg==",
+      "version": "20.17.14",
+      "resolved": "https://registry.npmjs.org/@types/node/-/node-20.17.14.tgz",
+      "integrity": "sha512-w6qdYetNL5KRBiSClK/KWai+2IMEJuAj+EujKCumalFOwXtvOXaEan9AuwcRID2IcOIAWSIfR495hBtgKlx2zg==",
       "dev": true,
@@ -34,5 +34,5 @@ "license": "MIT",
     "node_modules/@types/ssh2": {
-      "version": "1.15.3",
-      "resolved": "https://registry.npmjs.org/@types/ssh2/-/ssh2-1.15.3.tgz",
-      "integrity": "sha512-pUhXytp7aRAj1AKCQpdKNKGb32e53MUGPu186U9cm8mbX6kxF0UcngI/RVoKvJTWdHqDFiNrSDiPR/JZWexcCQ==",
+      "version": "1.15.4",
+      "resolved": "https://registry.npmjs.org/@types/ssh2/-/ssh2-1.15.4.tgz",
+      "integrity": "sha512-9JTQgVBWSgq6mAen6PVnrAmty1lqgCMvpfN+1Ck5WRUsyMYPa6qd50/vMJ0y1zkGpOEgLzm8m8Dx/Y5vRouLaA==",
       "dev": true,
@@ -45,5 +45,5 @@ "license": "MIT",
     "node_modules/@types/ssh2/node_modules/@types/node": {
-      "version": "18.19.69",
-      "resolved": "https://registry.npmjs.org/@types/node/-/node-18.19.69.tgz",
-      "integrity": "sha512-ECPdY1nlaiO/Y6GUnwgtAAhLNaQ53AyIVz+eILxpEo5OvuqE6yWkqWBIb5dU0DqhKQtMeny+FBD3PK6lm7L5xQ==",
+      "version": "18.19.71",
+      "resolved": "https://registry.npmjs.org/@types/node/-/node-18.19.71.tgz",
+      "integrity": "sha512-evXpcgtZm8FY4jqBSN8+DmOTcVkkvTmAayeo4Wf3m1xAruyVGzGuDh/Fb/WWX2yLItUiho42ozyJjB0dw//Tkw==",
       "dev": true,
@@ -506,5 +506,5 @@ "license": "MIT",
     "node_modules/typescript": {
-      "version": "5.7.2",
-      "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.7.2.tgz",
-      "integrity": "sha512-i5t66RHxDvVN40HfDd1PsEThGNnlMCMT3jMUuoh9/0TaqWevNontacunWyN02LA9/fIbEWlcHZcgTKb9QoaLfg==",
+      "version": "5.7.3",
+      "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.7.3.tgz",
+      "integrity": "sha512-84MVSjMEHP+FQRPy3pX9sTVV/INIex71s9TL2Gm5FG/WG1SqXeKyZ0k7/blY/4FdOzI12CBy1vGc4og/eus0fw==",
       "dev": true,
@@ -511,0 +511,0 @@ "license": "Apache-2.0",

dist/package.json

 {
   "name": "hivessh",
-  "version": "1.1.7",
+  "version": "1.1.8",
   "description": "HiveSsh simplifies SSH2 connections via promise-based task execution on Linux servers with built-in server utilities and powerful command execution functions",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

package.json

 {
   "name": "hivessh",
-  "version": "1.1.5",
+  "version": "1.1.6",
   "description": "HiveSsh simplifies SSH2 connections via promise-based task execution on Linux servers with built-in server utilities and powerful command execution functions",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

README.md

@@ -15,5 +15,5 @@ # HiveSsh
 
-HiveSsh simplifies SSH2 connections via promise-based task execution on Linux servers with built-in server utilities and powerful command execution functions.
+HiveSsh is an innovative library designed to streamline SSH2 connections and simplify task execution on Linux servers.
 
-HiveSsh is a library designed to streamline SSH2 connections and task execution on Linux servers. It provides user-friendly promise-based functions for efficient server operations without the need for a client application.
+It wraps around the ssh2-library, offering a [promise-based approach](#promisified) to avoid nested callbacks and adding useful features like [command existence checks](#command-existence-checks) and persistent [exec sessions](#exec-session).
 
@@ -38,2 +38,8 @@ ----
 
+# SSH2
+The term `ssh2` has two meanings here, the `secure shell protocol` and the `npm library`. 
+When referring to the npm library, this repo will always refer to it as the `ssh2`-library.
+
+HiveSsh is a wrapper library of the `ssh2`-library with additional features and promise-based task execution instead of a callback function approach.
+
 # Key Features
@@ -93,3 +99,3 @@ HiveSsh offers the following key features:
 ## Promisified
-### Execute and assets
+### Execute
 
@@ -103,2 +109,15 @@ After connecting an `SshHost`, you can use the promisified execution (and other asset features) directly on the `SshHost` instance.
 
+### Execute at
+
+You can also execute commands on absolut path:
+```ts
+const etcDirFiles = await myHost.exec(
+  "ls -al",
+  { pwd: "/etc" }
+)
+console.log("Etc files: ", etcDirFiles.out)
+```
+
+### Command existence checks
+
 Get the hosts public ip address:
@@ -118,11 +137,2 @@ ```ts
 
-You can also execute commands on absolut path:
-```ts
-const etcDirFiles = await myHost.exec(
-  "ls -al",
-  { pwd: "/etc" }
-)
-console.log("Etc files: ", etcDirFiles.out)
-```
-
 Also a git example:
@@ -226,3 +236,3 @@ ```ts
 - **Node.js**
-- **SSH2** ([NPM Package](https://www.npmjs.com/package/ssh2) & Protocol)
+- [`ssh2`-library](https://www.npmjs.com/package/ssh2)
 
@@ -229,0 +239,0 @@ # Contributing

No alert changes

Improved metrics

Total package byte prevSize

346302

increased by0.1%

Number of lines in readme file

244

increased by4.27%

No dependency changes