package.json

{
  "name": "embedded-device-logger",
  "displayName": "Embedded Device Logger",
  "description": "Stream and filter embedded Linux device logs over SSH inside VS Code.",
  "icon": "media/icon.png",
  "version": "1.9.21",
  "publisher": "Scallant",
  "author": "A. Scillato",
  "engines": {
    "vscode": "^1.124.0"
  },
  "repository": {
    "type": "git",
    "url": "https://github.com/ascillato/VSCode-Logger"
  },
  "extensionKind": [
    "ui",
    "workspace"
  ],
  "bugs": {
    "url": "https://github.com/ascillato/VSCode-Logger/issues",
    "email": "logger_issues@scallant.com"
  },
  "homepage": "https://ascillato.github.io/VSCode-Logger",
  "license": "MIT",
  "pricing": "Free",
  "galleryBanner": {
    "color": "#1E1E1E",
    "theme": "dark"
  },
  "categories": [
    "Debuggers",
    "Education"
  ],
  "keywords": [
    "ssh",
    "logger",
    "embedded-linux",
    "debugging"
  ],
  "main": "./out/extension.js",
  "contributes": {
    "configuration": {
      "title": "Embedded Device Logger",
      "properties": {
        "embeddedLogger.language": {
          "type": "string",
          "scope": "resource",
          "default": "vscode",
          "enum": [
            "vscode",
            "en",
            "es",
            "it",
            "zh-cn",
            "zh-tw",
            "fr",
            "de",
            "ja",
            "ko",
            "ru",
            "pt-br",
            "tr",
            "pl",
            "cs",
            "hu"
          ],
          "enumItemLabels": [
            "VSCode default",
            "English",
            "Spanish",
            "Italian",
            "Simplified Chinese",
            "Traditional Chinese",
            "French",
            "German",
            "Japanese",
            "Korean",
            "Russian",
            "Portuguese (Brazil)",
            "Turkish",
            "Polish",
            "Czech",
            "Hungarian"
          ],
          "description": "Language used by the extension UI. VSCode default follows Configure Display Language and falls back to English for unsupported display languages."
        },
        "embeddedLogger.defaultPort": {
          "type": "number",
          "scope": "resource",
          "default": 22,
          "description": "Default SSH port applied to devices that do not specify one.",
          "minimum": 1
        },
        "embeddedLogger.defaultLogCommand": {
          "type": "string",
          "scope": "resource",
          "default": "tail -F /var/log/syslog",
          "description": "Default log command used when a device omits logCommand."
        },
        "embeddedLogger.defaultEnableSshTerminal": {
          "type": "boolean",
          "scope": "resource",
          "default": true,
          "description": "Whether devices without an explicit enableSshTerminal flag should show the SSH terminal action."
        },
        "embeddedLogger.defaultEnableSftpExplorer": {
          "type": "boolean",
          "scope": "resource",
          "default": true,
          "description": "Whether devices without an explicit enableSftpExplorer flag should show the SFTP explorer action."
        },
        "embeddedLogger.defaultEnableWebBrowser": {
          "type": "boolean",
          "scope": "resource",
          "default": true,
          "description": "Whether devices without an explicit enableWebBrowser flag should show the external web browser action."
        },
        "embeddedLogger.defaultEnableEmbeddedWebBrowser": {
          "type": "boolean",
          "scope": "resource",
          "default": true,
          "description": "Whether devices without an explicit enableEmbeddedWebBrowser flag should show the embedded web browser action."
        },
        "embeddedLogger.defaultSshCommands": {
          "type": "array",
          "scope": "resource",
          "description": "Reusable SSH commands that can be shown before each device's own SSH commands in the Devices view.",
          "markdownDescription": "Reusable SSH commands that can be shown before each device's own SSH commands in the Devices view.\n\nEach device can disable them with `showDefaultSshCommands: false` to show only its device-specific commands.\n\nWhen `copyAndRunScript` is enabled, the optional `script` is copied to `/tmp`, made executable with `chmod 777`, and run after the optional `command`.\n\nExample:\n```json\n[\n  {\n    \"name\": \"🔁 Reboot\",\n    \"command\": \"reboot\",\n    \"openSshPanel\": false,\n    \"rerunOnReconnection\": false\n  },\n  {\n    \"name\": \"⚙️ Restart Service\",\n    \"command\": \"systemctl restart my-service\",\n    \"openSshPanel\": false,\n    \"rerunOnReconnection\": false\n  },\n  {\n    \"name\": \"📈 Processes\",\n    \"command\": \"top\",\n    \"openSshPanel\": true,\n    \"rerunOnReconnection\": true\n  },\n  {\n    \"name\": \"🚀 Deploy helper\",\n    \"command\": \"echo Preparing deployment\",\n    \"copyAndRunScript\": true,\n    \"script\": \"#!/bin/sh\\nprintf \\\"Deploying on %s\\\\n\\\" \\\"$(hostname)\\\"\\n\"\n  }\n]\n```",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string",
                "description": "Display name for the SSH command."
              },
              "command": {
                "type": "string",
                "description": "Optional command to execute before the uploaded script runs."
              },
              "openSshPanel": {
                "type": "boolean",
                "description": "Whether to open the command in an SSH terminal panel and keep the session open.",
                "default": false
              },
              "rerunOnReconnection": {
                "type": "boolean",
                "description": "Whether an SSH-panel command should be re-run automatically after the panel reconnects.",
                "default": false
              },
              "copyAndRunScript": {
                "type": "boolean",
                "description": "Whether to copy the configured script to /tmp over SFTP, set chmod 777, and run it after the optional command.",
                "default": false
              },
              "script": {
                "type": "string",
                "description": "Optional script content to copy to /tmp and run when copyAndRunScript is enabled."
              }
            },
            "required": [
              "name"
            ]
          },
          "default": []
        },
        "embeddedLogger.groups": {
          "type": "array",
          "scope": "resource",
          "default": [],
          "description": "Optional ordered list of device groups displayed in the Embedded Devices view.",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "name": {
                "type": "string",
                "description": "Group name shown in the devices view."
              }
            },
            "required": [
              "name"
            ]
          }
        },
        "embeddedLogger.devices": {
          "type": "array",
          "scope": "resource",
          "description": "List of embedded devices to stream logs from.",
          "markdownDescription": "List of embedded devices to stream logs from.\n\nManage devices with the **Embedded Logger: Edit Devices Configuration** Device Manager (table UI with add/remove rows and all user-editable fields). The internal `id` is generated automatically and kept unique when devices are added, saved, exported, or imported. You can also choose **Edit in settings.json** for direct JSON editing.\n\nWhen `copyAndRunScript` is enabled for an SSH command, the optional `script` is copied to `/tmp`, made executable with `chmod 777`, and run after the optional `command`.\n\nExample:\n```json\n[\n  {\n    \"group\": \"Lab\",\n    \"color\": \"#4fc3f7\",\n    \"name\": \"Raspberry Pi 4\",\n    \"host\": \"192.168.1.50\",\n    \"hostFingerprint\": \"SHA256:your-base64-fingerprint\",\n    \"secondaryHost\": \"192.168.1.51\",\n    \"secondaryHostFingerprint\": \"SHA256:secondary-base64-fingerprint\",\n    \"port\": 22,\n    \"username\": \"pi\",\n    \"password\": \"\",\n    \"privateKeyPath\": \"/home/user/.ssh/id_ed25519\",\n    \"privateKeyPassphrase\": \"${env:KEY_PASSPHRASE}\",\n    \"logCommand\": \"journalctl -f -u app.service\",\n    \"enableSshTerminal\": true,\n    \"enableSftpExplorer\": true,\n    \"enableWebBrowser\": false,\n    \"enableEmbeddedWebBrowser\": false,\n    \"webBrowserUrl\": \"http://192.168.1.50\",\n    \"showDefaultSshCommands\": true,\n    \"sshCommands\": [\n      {\n        \"name\": \"🔁 Reboot\",\n        \"command\": \"reboot\",\n        \"openSshPanel\": false,\n        \"rerunOnReconnection\": false\n      },\n      {\n        \"name\": \"⚙️ Restart Service\",\n        \"command\": \"systemctl restart my-service\",\n        \"openSshPanel\": false,\n        \"rerunOnReconnection\": false\n      },\n      {\n        \"name\": \"📈 Processes\",\n        \"command\": \"top\",\n        \"openSshPanel\": true,\n        \"rerunOnReconnection\": true\n      },\n      {\n        \"name\": \"🚀 Deploy helper\",\n        \"command\": \"echo Preparing deployment\",\n        \"copyAndRunScript\": true,\n        \"script\": \"#!/bin/sh\\nprintf \\\"Deploying on %s\\\\n\\\" \\\"$(hostname)\\\"\\n\"\n      }\n    ],\n    \"bastion\": {\n      \"host\": \"bastion.example.com\",\n      \"hostFingerprint\": \"SHA256:bastion-fingerprint\",\n      \"port\": 22,\n      \"username\": \"jump-user\",\n      \"password\": \"\",\n      \"privateKeyPath\": \"${env:HOME}/.ssh/id_ed25519\",\n      \"privateKeyPassphrase\": \"\"\n    }\n  }\n]\n```",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "defaultSnippets": [
              {
                "label": "New embedded device",
                "body": {
                  "group": "${1:Lab}",
                  "color": "#4fc3f7",
                  "name": "${2:Device name}",
                  "host": "${3:192.168.1.10}",
                  "hostFingerprint": "SHA256:${4:device-fingerprint}",
                  "secondaryHost": "${5:}",
                  "secondaryHostFingerprint": "SHA256:${6:secondary-fingerprint}",
                  "port": 22,
                  "username": "${7:root}",
                  "password": "",
                  "privateKeyPath": "${8:${env:HOME}/.ssh/id_ed25519}",
                  "privateKeyPassphrase": "",
                  "logCommand": "tail -F /var/log/syslog",
                  "enableSshTerminal": true,
                  "enableSftpExplorer": true,
                  "enableWebBrowser": false,
                  "enableEmbeddedWebBrowser": false,
                  "webBrowserUrl": "${9:http://192.168.1.10}",
                  "showDefaultSshCommands": true,
                  "sshCommands": [
                    {
                      "name": "Restart Service",
                      "command": "systemctl restart my-service"
                    },
                    {
                      "name": "Follow Service Logs",
                      "command": "journalctl -f -u my-service",
                      "openSshPanel": true,
                      "rerunOnReconnection": true
                    },
                    {
                      "name": "Deploy helper",
                      "command": "echo Preparing deployment",
                      "copyAndRunScript": true,
                      "script": "#!/bin/sh\nprintf \"Deploying on %s\\n\" \"$(hostname)\"\n"
                    }
                  ],
                  "bastion": {
                    "host": "${10:bastion.example.com}",
                    "hostFingerprint": "SHA256:${11:bastion-fingerprint}",
                    "port": 22,
                    "username": "${12:jump-user}",
                    "password": "",
                    "privateKeyPath": "${13:${env:HOME}/.ssh/id_ed25519}",
                    "privateKeyPassphrase": ""
                  }
                }
              }
            ],
            "properties": {
              "id": {
                "type": "string",
                "description": "Internal unique identifier for the device. The Device Manager generates this automatically; existing values are preserved when unique."
              },
              "group": {
                "type": "string",
                "description": "Optional group name used to nest this device under a collapsible group in the Embedded Devices view."
              },
              "color": {
                "type": "string",
                "description": "Optional color for the device indicator and related tabs (defaults to the editor tab title color)."
              },
              "name": {
                "type": "string",
                "description": "Friendly name shown in the sidebar."
              },
              "host": {
                "type": "string",
                "description": "Hostname or IP address."
              },
              "hostFingerprint": {
                "type": "string",
                "description": "SHA256 fingerprint of the device's SSH host key (for example, output of ssh-keygen -lf -E sha256)."
              },
              "secondaryHost": {
                "type": "string",
                "description": "Optional fallback hostname or IP address to try when the primary host is unavailable."
              },
              "secondaryHostFingerprint": {
                "type": "string",
                "description": "SHA256 fingerprint of the fallback host's SSH key."
              },
              "bastion": {
                "type": "object",
                "description": "Optional bastion/jump host to reach the device through.",
                "additionalProperties": false,
                "properties": {
                  "host": {
                    "type": "string",
                    "description": "Hostname or IP address of the bastion host."
                  },
                  "hostFingerprint": {
                    "type": "string",
                    "description": "SHA256 fingerprint of the bastion host's SSH key."
                  },
                  "port": {
                    "type": "number",
                    "default": 22,
                    "description": "SSH port for the bastion host."
                  },
                  "username": {
                    "type": "string",
                    "description": "SSH username for the bastion host."
                  },
                  "password": {
                    "type": "string",
                    "description": "Password field for the bastion; stored to secret storage on first use.",
                    "default": ""
                  },
                  "privateKeyPath": {
                    "type": "string",
                    "description": "Path to an SSH private key for the bastion host.",
                    "default": ""
                  },
                  "privateKeyPassphrase": {
                    "type": "string",
                    "description": "Passphrase field for bastion keys; stored to secret storage on first use.",
                    "default": ""
                  }
                },
                "required": [
                  "host",
                  "username"
                ]
              },
              "port": {
                "type": "number",
                "default": 22,
                "description": "SSH port."
              },
              "username": {
                "type": "string",
                "description": "SSH username."
              },
              "password": {
                "type": "string",
                "description": "Password field; stored to secret storage on first use.",
                "default": ""
              },
              "privateKeyPath": {
                "type": "string",
                "description": "Path to an SSH private key to authenticate with instead of a password.",
                "markdownDescription": "Path to an SSH private key to authenticate with instead of a password.\n\nExamples:\n- `/home/user/.ssh/id_ed25519`\n- `${env:HOME}/.ssh/id_rsa`",
                "default": ""
              },
              "privateKeyPassphrase": {
                "type": "string",
                "description": "Passphrase field for encrypted keys; stored to secret storage on first use.",
                "default": ""
              },
              "logCommand": {
                "type": "string",
                "description": "Command to stream logs (defaults to tail -F /var/log/syslog).",
                "default": "tail -F /var/log/syslog"
              },
              "enableSshTerminal": {
                "type": "boolean",
                "default": false,
                "description": "Whether to show an Open SSH Terminal action for this device."
              },
              "enableSftpExplorer": {
                "type": "boolean",
                "default": false,
                "description": "Whether to show an Open SFTP Explorer action for this device."
              },
              "enableWebBrowser": {
                "type": "boolean",
                "default": false,
                "description": "Whether to show an Open External Web Browser action for this device."
              },
              "enableEmbeddedWebBrowser": {
                "type": "boolean",
                "default": false,
                "description": "Whether to show an Open Embedded Web Browser action for this device."
              },
              "webBrowserUrl": {
                "type": "string",
                "description": "Optional URL to open for the device; defaults to http://<host> when omitted.",
                "default": ""
              },
              "showDefaultSshCommands": {
                "type": "boolean",
                "default": true,
                "description": "Whether to prepend embeddedLogger.defaultSshCommands before this device's own sshCommands in the Devices view."
              },
              "sftpPresetsRemote": {
                "type": "array",
                "description": "Saved remote-path presets for the device's SFTP explorer.",
                "items": {
                  "type": "string"
                },
                "maxItems": 10,
                "default": []
              },
              "sftpPresetsLocal": {
                "type": "array",
                "description": "Saved local-path presets for the device's SFTP explorer.",
                "items": {
                  "type": "string"
                },
                "maxItems": 10,
                "default": []
              },
              "sshCommands": {
                "type": "array",
                "description": "Optional list of on-demand SSH commands available from the Devices view.",
                "items": {
                  "type": "object",
                  "properties": {
                    "name": {
                      "type": "string",
                      "description": "Display name for the SSH command."
                    },
                    "command": {
                      "type": "string",
                      "description": "Optional command to execute before the uploaded script runs."
                    },
                    "openSshPanel": {
                      "type": "boolean",
                      "description": "Whether to open the command in an SSH terminal panel and keep the session open.",
                      "default": false
                    },
                    "rerunOnReconnection": {
                      "type": "boolean",
                      "description": "Whether an SSH-panel command should be re-run automatically after the panel reconnects.",
                      "default": false
                    },
                    "copyAndRunScript": {
                      "type": "boolean",
                      "description": "Whether to copy the configured script to /tmp over SFTP, set chmod 777, and run it after the optional command.",
                      "default": false
                    },
                    "script": {
                      "type": "string",
                      "description": "Optional script content to copy to /tmp and run when copyAndRunScript is enabled."
                    }
                  },
                  "required": [
                    "name"
                  ]
                }
              }
            },
            "required": [
              "name",
              "host",
              "username"
            ]
          },
          "default": [
            {
              "color": "#4fc3f7",
              "name": "Device A",
              "host": "192.168.1.10",
              "hostFingerprint": "SHA256:replace-with-device-fingerprint",
              "bastion": {
                "host": "bastion.example.com",
                "hostFingerprint": "SHA256:replace-with-bastion-fingerprint",
                "port": 22,
                "username": "jump"
              },
              "port": 22,
              "privateKeyPath": "${env:HOME}/.ssh/id_ed25519",
              "username": "root",
              "logCommand": "tail -F /var/log/syslog",
              "enableSshTerminal": true,
              "enableSftpExplorer": true,
              "enableWebBrowser": false,
              "enableEmbeddedWebBrowser": false,
              "webBrowserUrl": "http://192.168.1.10",
              "showDefaultSshCommands": true,
              "sftpPresetsRemote": [
                "/var/log",
                "/opt/app"
              ],
              "sftpPresetsLocal": [
                "${env:HOME}/Downloads",
                "${env:HOME}/Projects"
              ],
              "sshCommands": [
                {
                  "name": "Restart Service",
                  "command": "systemctl restart my-service"
                },
                {
                  "name": "Follow Service Logs",
                  "command": "journalctl -f -u my-service",
                  "openSshPanel": true,
                  "rerunOnReconnection": true
                },
                {
                  "name": "Deploy helper",
                  "command": "echo Preparing deployment",
                  "copyAndRunScript": true,
                  "script": "#!/bin/sh\nprintf \"Deploying on %s\\n\" \"$(hostname)\"\n"
                }
              ]
            }
          ]
        },
        "embeddedLogger.maxLinesPerTab": {
          "type": "number",
          "scope": "resource",
          "default": 100000,
          "description": "Maximum number of log lines retained per log tab before older lines are discarded.",
          "minimum": 1
        },
        "embeddedLogger.enableDevicePing": {
          "type": "boolean",
          "scope": "resource",
          "default": true,
          "description": "Enable ping checks for configured devices and show ping indicators in the Devices view."
        },
        "embeddedLogger.devicePingIntervalSeconds": {
          "type": [
            "number",
            "null"
          ],
          "scope": "resource",
          "default": null,
          "minimum": 1,
          "description": "Optional ping interval in seconds. Leave empty to ping only when the Ping button is pressed."
        }
      }
    },
    "viewsContainers": {
      "activitybar": [
        {
          "id": "embeddedLogger",
          "title": "%embeddedLogger.viewsContainers.activitybar.title%",
          "icon": "resources/terminal.svg"
        }
      ]
    },
    "views": {
      "embeddedLogger": [
        {
          "id": "embeddedLogger.devicesView",
          "name": "%embeddedLogger.views.devicesView.name%",
          "type": "webview",
          "icon": "resources/terminal.svg"
        }
      ]
    },
    "activationEvents": [
      "onView:embeddedLogger.devicesView",
      "onCommand:embeddedLogger.openLocalLogFile",
      "onCommand:embeddedLogger.editDevicesConfig",
      "onCommand:embeddedLogger.clearStoredPasswords",
      "onCommand:embeddedLogger.openSftpExplorer",
      "onCommand:embeddedLogger.openWebBrowser",
      "onCommand:embeddedLogger.openEmbeddedWebBrowser",
      "onCommand:embeddedLogger.pingAllDevices"
    ],
    "commands": [
      {
        "command": "embeddedLogger.openLocalLogFile",
        "title": "%embeddedLogger.commands.openLocalLogFile.title%",
        "shortTitle": "%embeddedLogger.commands.openLocalLogFile.title%",
        "icon": "$(file-text)"
      },
      {
        "command": "embeddedLogger.openDevice",
        "title": "Open Embedded Device Logs"
      },
      {
        "command": "embeddedLogger.editDevicesConfig",
        "title": "%embeddedLogger.commands.editDevicesConfig.title%",
        "shortTitle": "%embeddedLogger.commands.editDevicesConfig.title%",
        "icon": "$(pencil)"
      },
      {
        "command": "embeddedLogger.clearStoredPasswords",
        "title": "Remove Stored Passwords",
        "icon": "$(trash)"
      },
      {
        "command": "embeddedLogger.openSftpExplorer",
        "title": "Open SFTP Explorer"
      },
      {
        "command": "embeddedLogger.openWebBrowser",
        "title": "Open External Web Browser"
      },
      {
        "command": "embeddedLogger.openEmbeddedWebBrowser",
        "title": "Open Embedded Web Browser"
      },
      {
        "command": "embeddedLogger.pingAllDevices",
        "title": "%embeddedLogger.commands.pingAllDevices.title%",
        "shortTitle": "%embeddedLogger.commands.pingAllDevices.title%",
        "icon": "$(pulse)"
      }
    ],
    "menus": {
      "view/title": [
        {
          "command": "embeddedLogger.pingAllDevices",
          "when": "view == embeddedLogger.devicesView && embeddedLogger.devicePingEnabled",
          "group": "navigation@0"
        },
        {
          "command": "embeddedLogger.openLocalLogFile",
          "when": "view == embeddedLogger.devicesView",
          "group": "navigation@1"
        },
        {
          "command": "embeddedLogger.editDevicesConfig",
          "when": "view == embeddedLogger.devicesView",
          "group": "navigation@2"
        }
      ]
    }
  },
  "scripts": {
    "vscode:prepublish": "npm run compile",
    "typecheck": "tsc --noEmit -p ./",
    "bundle": "node ./scripts/esbuild.mjs",
    "bundle:watch": "node ./scripts/esbuild.mjs --watch",
    "compile": "npm run typecheck && npm run bundle",
    "package:vsix": "npm exec --yes --loglevel=error --package @vscode/vsce@3.9.2 -- vsce package",
    "watch": "npm run bundle:watch",
    "lint": "eslint .",
    "lint:fix": "eslint . --fix",
    "lint:docs": "cspell --config ./cspell.json --no-progress \"*.md\" \"docs/**/*.{md,txt}\"",
    "format": "prettier --write .",
    "format:check": "prettier --check .",
    "docs:typedoc": "typedoc --options typedoc.json",
    "test": "npm run test:coverage && npm run coverage:report && npm run test:e2e",
    "test:unit": "vitest run --config vitest.config.ts tests/unit",
    "test:integration": "vitest run --config vitest.config.ts tests/integration",
    "test:coverage": "vitest run --config vitest.config.ts --coverage",
    "coverage:report": "python3 docs/source/coverage_report.py || python docs/source/coverage_report.py",
    "test:e2e": "npm run compile && node ./tests/e2e/runTest.js"
  },
  "devDependencies": {
    "@eslint/compat": "^2.1.0",
    "@eslint/eslintrc": "^3.3.6",
    "@eslint/js": "^10.0.1",
    "@types/mocha": "^10.0.10",
    "@types/node": "^26.2.0",
    "@types/vscode": "^1.124.0",
    "@typescript-eslint/eslint-plugin": "^8.67.0",
    "@typescript-eslint/parser": "^8.67.0",
    "@vitest/coverage-v8": "^4.1.11",
    "@vscode/test-electron": "^3.1.0",
    "cloc": "^2.6.0-cloc",
    "cspell": "^10.0.1",
    "esbuild": "^0.28.2",
    "eslint": "^10.8.1",
    "eslint-config-prettier": "^10.1.8",
    "eslint-plugin-prettier": "^5.5.6",
    "eslint-plugin-spellcheck": "^0.0.20",
    "globals": "^17.11.0",
    "mocha": "^11.8.0",
    "prettier": "^3.9.6",
    "typedoc": "^0.28.20",
    "typescript": "^6.0.3",
    "vitest": "^4.1.11"
  },
  "dependencies": {
    "ssh2": "^1.14.0"
  },
  "allowScripts": {
    "cpu-features@0.0.10": true,
    "fsevents@2.3.3": true,
    "ssh2@1.17.0": true,
    "esbuild@0.28.2": true
  },
  "overrides": {
    "diff": "^8.0.3",
    "serialize-javascript": "^7.0.5"
  }
}