Added screen shots and remote connectivity cleanup

Author: DamianSuess

docs/ScreenShot-MenuItems.png

@@ -1,25 +1,38 @@
 # [VS .NET SSH Debugger](https://github.com/SuessLabs/RemoteDebug.git)
 
-Remotely deploy and debug your .NET C# apps via SSH to Linux using Visual Studio.
+Remotely deploy and debug your .NET C# apps via SSH to Linux using Visual Studio 2022.
 
 > WARNING: This is a work in progress!
 
 Visual Studio's "attach to process via SSH" is cute, but it lacks deployment and automatic attaching. This project aims to allow you to do just that when programming for your Linux VM or Raspberry Pi over the network.
 
-This project was inspired by [VS Mono Debugger](https://github.com/GordianDotNet/VSMonoDebugger).
+This project was inspired by [VS Mono Debugger](https://github.com/GordianDotNet/VSMonoDebugger) and their amazing efforts for cross-platform development.
 
-## To Do
+## Overview
+
+Allow developers to build, deploy and debug projects on their remote Linux (Ubuntu, Raspberry PI, etc) devices! Users can choose to use SSH with either a _private key_ or _password_.
+
+### Usage
+
+![VS Menu](docs/ScreenShot-MenuItems.png)
+
+* Build and upload to remote devices (_yes, this is a real pain_)
+* Remote debugging (_Work-in-Progress_)
+
+### Customize your connections
+
+![Tools Options](docs/ScreenShot-ToolsOptions.png)
+
+## Action Items
 
 In order to get this project moving, the following must be done.
 
-* [X] Create extension project for VS2022 (_VS2019 coming soon_).
-* [X] SSH library
-* [X] SFTP library
-* [ ] Store settings (globally; per-project)
-  * IP, User, Pass, default-folder `"~\.XRemoteDbg\(proj-name)"`
-* [ ] TEST: Perform upload to remote machine
-* [ ] TEST: Attach to process
-* [ ] Figure out how to, OnRun: upload, attach, remote-debug
+* [X] Create extension project for VS2022
+* [X] SSH, SFTP, and SCP communication
+* [X] Store settings (globally; per-project)
+  * [X] IP, User, Pass, default-folder `"~/VsLinuxDbg/(proj-name)"`
+* [X] Perform upload to remote machine
+* [ ] Attach to process
 
 ## References
 

docs/ScreenShot-ToolsOptions.png

@@ -78,8 +78,8 @@ private void MessageBox(string message, string title = "Error") => VsShellUtilit
     /// <summary>VS Menu Command IDs. This must be insync with .vsct values.</summary>
     private sealed class CommandIds
     {
-      public const int CmdBuildDeployDebug = 0x1002;
       public const int CmdBuildDeployOnly = 0x1001;
+      public const int CmdBuildDeployDebug = 0x1002;
       public const int CmdDebugOnly = 0x1003;
       ////public const int CmdPublishOnly = 0x1006;
       ////public const int CmdPublishDebug= 0x1007;

readme.md

@@ -158,8 +158,8 @@ private void BuildBegin()
 
     private void BuildCleanup()
     {
-      // TODO: The file should be located in the project's output
-      File.Delete(_launchJsonPath);
+      if (File.Exists(_launchJsonPath))
+        File.Delete(_launchJsonPath);
 
       //// BuildEvents.OnBuildDone -= BuildEvents_OnBuildDoneAsync;
       //// BuildEvents.OnBuildProjConfigDone -= BuildEvents_OnBuildProjConfigDone;

src/VsLinuxDebugger/Commands.cs

@@ -37,6 +37,7 @@ public string Bash(string command)
             return "Cannot connect to remote host to execute Bash command.";
         }
 
+        LogOutput($"BASH> {command}");
         var cmd = _ssh.RunCommand(command);
 
         return cmd.Result;
@@ -48,18 +49,26 @@ public string Bash(string command)
     }
 
     /// <summary>Cleans the contents of the deployment path.</summary>
-    public void CleanDeploymentFolder() => Bash($"sudo rm -rf {_opts.RemoteDeployBasePath}/*");
+    public void CleanDeploymentFolder()
+    {
+      //// Bash($"sudo rm -rf {_opts.RemoteDeployBasePath}/*");
+      Bash($"rm -rf {_opts.RemoteDeployBasePath}/*");
+    }
 
     public bool Connect()
     {
       PrivateKeyFile keyFile = null;
       try
       {
-        keyFile = new PrivateKeyFile(_opts.UserPrivateKeyPath);
+        if (_opts.UserPrivateKeyEnabled)
+          keyFile = new PrivateKeyFile(_opts.UserPrivateKeyPath);
         //// keyFile = new PrivateKeyFile(_opts.UserKeyFilePath, password);
       }
-      catch (Exception)
+      catch (Exception ex)
       {
+        LogOutput($"Private key error - {ex.Message}");
+        LogOutput("Issue obtaining private key. Please check your settings to ensure a valid file exists (Tools > Options).");
+        return false;
       }
 
       try
@@ -114,9 +123,10 @@ public void Dispose()
 
     public void MakeDeploymentFolder()
     {
-      Bash($"sudo mkdir -p {_opts.RemoteDeployBasePath}");
-      Bash($"sudo mkdir -p {_opts.RemoteDeployDebugPath}");
-      Bash($"sudo mkdir -p {_opts.RemoteDeployReleasePath}");
+      // do we need SUDO?
+      Bash($"mkdir -p {_opts.RemoteDeployBasePath}");
+      Bash($"mkdir -p {_opts.RemoteDeployDebugPath}");
+      Bash($"mkdir -p {_opts.RemoteDeployReleasePath}");
 
       var group = string.IsNullOrEmpty(_opts.UserGroupName)
         ? string.Empty
@@ -363,8 +373,10 @@ private bool PayloadDecompress(string pathBuildTarGz, bool removeTarGz = true)
     {
       try
       {
-        var cmd = $"set -e;cd \"{_opts.RemoteDeployDebugPath}\"";
-        cmd += $";tar -zxf \"{pathBuildTarGz}\"";
+        var cmd = "set -e";
+        cmd += $";cd \"{_opts.RemoteDeployDebugPath}\"";
+        cmd += $";tar -zxf \"{_tarGzFileName}\"";
+        ////cmd += $";tar -zxf \"{pathBuildTarGz}\"";
 
         if (removeTarGz)
           cmd += $";rm \"{pathBuildTarGz}\"";

src/VsLinuxDebugger/Core/RemoteDebugger.cs

@@ -43,7 +43,7 @@
         </Strings>
       </Menu>
     </Menus>
-    
+
     <!-- In this section you can define new menu groups. A menu group is a container for
          other menus or buttons (commands); from a visual point of view you can see the
          group as the part of a menu contained between two lines. The parent of a group
@@ -92,7 +92,7 @@
           <ButtonText>Build, Deploy and Debug</ButtonText>
         </Strings>
       </Button>
-      
+
       <Button guid="GuidLinuxDebugerMenu" id="CmdDebugOnly" priority="0x0402" type="Button">
         <Parent guid="GuidLinuxDebugerMenu" id="RemoteMainMenuGroupLevel1" />
         <CommandFlag>DynamicVisibility</CommandFlag>
@@ -103,6 +103,10 @@
         </Strings>
       </Button>
 
+      <!--
+      TODO: Publish & Publish and Debug
+      -->
+
       <Button guid="GuidLinuxDebugerMenu" id="CmdOpenLogs" priority="0x0500" type="Button">
         <Parent guid="GuidLinuxDebugerMenu" id="RemoteMainMenuGroupLevel2" />
         <CommandFlag>DynamicVisibility</CommandFlag>
@@ -124,7 +128,6 @@
           <ButtonText>Settings</ButtonText>
         </Strings>
       </Button>
-
     </Buttons>
 
     <!--The bitmaps section is used to define the bitmaps that are used for the commands.-->
@@ -165,24 +168,24 @@
       <IDSymbol name="CmdOpenLogs" value="0x1004" />
       <IDSymbol name="CmdOpenSettings" value="0x1005" />
     </GuidSymbol>
-  
-    <GuidSymbol name="DeployAndDebug_16x" value="{B3A9DD89-C898-4AFE-AC48-3A4C84122475}" >
+
+    <GuidSymbol name="DeployAndDebug_16x" value="{B3A9DD89-C898-4AFE-AC48-3A4C84122475}">
       <IDSymbol name="imgDeployAndDebug" value="1" />
     </GuidSymbol>
-    
-    <GuidSymbol name="DeployOnly_16x" value="{00AD8C85-F4CF-4EFA-8C8E-3ADE51071088}" >
+
+    <GuidSymbol name="DeployOnly_16x" value="{00AD8C85-F4CF-4EFA-8C8E-3ADE51071088}">
       <IDSymbol name="imgDeployOnly" value="1" />
     </GuidSymbol>
 
-    <GuidSymbol name="DebugOnly_16x" value="{0164DE8A-8EAB-40CE-9607-C6D15882A91A}" >
+    <GuidSymbol name="DebugOnly_16x" value="{0164DE8A-8EAB-40CE-9607-C6D15882A91A}">
       <IDSymbol name="imgDebugOnly" value="1" />
     </GuidSymbol>
 
-    <GuidSymbol name="ShowLog_16x" value="{5B4A8C21-9884-4A10-B028-1BC98C324B10}" >
+    <GuidSymbol name="ShowLog_16x" value="{5B4A8C21-9884-4A10-B028-1BC98C324B10}">
       <IDSymbol name="imgShowLog" value="1" />
     </GuidSymbol>
-    
-    <GuidSymbol name="Settings_16x" value="{AFAE921E-9A65-44E9-90CE-022DB84EE5BB}" >
+
+    <GuidSymbol name="Settings_16x" value="{AFAE921E-9A65-44E9-90CE-022DB84EE5BB}">
       <IDSymbol name="imgSettings" value="1" />
     </GuidSymbol>
 

src/VsLinuxDebugger/Core/SshTool.cs

@@ -10,8 +10,8 @@ public partial class OptionsPage : DialogPage
     private const string Credientials = "Remote Credientials";
 
     [Category(Credientials)]
-    [DisplayName("IP Address")]
-    [Description("IP Address")]
+    [DisplayName("Host IP Address")]
+    [Description("Host IP Address. On VMs using 'NAT', set IP to '127.0.0.1' and forward Port 22. PCs and VMs 'Bridged', have their own IP.")]
     public string HostIp { get; set; } = "127.0.0.1";
 
     [Category(Credientials)]