Include platform support and preview status in generated Markdown help

nblumhardt · nblumhardt · commit 272f23271cda · 2025-07-24T10:26:47.000+10:00
diff --git a/src/SeqCli/Cli/CommandAttribute.cs b/src/SeqCli/Cli/CommandAttribute.cs
@@ -24,16 +24,18 @@ public class CommandAttribute : Attribute, ICommandMetadata
     public string HelpText { get; }
     public string? Example { get; set; }
     public FeatureVisibility Visibility { get; set; }
+    public SupportedPlatforms Platforms { get; set; }
 
     public CommandAttribute(string name, string helpText)
     {
         Name = name;
         HelpText = helpText;
         Visibility = FeatureVisibility.Visible;
+        Platforms = SupportedPlatforms.All;
     }
 
     public CommandAttribute(string name, string subCommand, string helpText) : this(name, helpText)
     {
         SubCommand = subCommand;
     }
-}
+}
diff --git a/src/SeqCli/Cli/CommandLineHost.cs b/src/SeqCli/Cli/CommandLineHost.cs
@@ -16,6 +16,7 @@
 using System.Collections.Generic;
 using System.Linq;
 using System.Reflection;
+using System.Runtime.InteropServices;
 using System.Threading.Tasks;
 using Autofac.Features.Metadata;
 using Serilog.Core;
@@ -55,8 +56,12 @@ public async Task<int> Run(string[] args, LoggingLevelSwitch levelSwitch)
             if (args.Any(a => a.Trim() is prereleaseArg))
                 featureVisibility |= FeatureVisibility.Preview;
             
+            var currentPlatform = RuntimeInformation.IsOSPlatform(OSPlatform.Windows)
+                ? SupportedPlatforms.Windows
+                : SupportedPlatforms.Unix;
+            
             var cmd = _availableCommands.SingleOrDefault(c =>
-                featureVisibility.HasFlag(c.Metadata.Visibility) &&
+                c.Metadata.Platforms.HasFlag(currentPlatform) && featureVisibility.HasFlag(c.Metadata.Visibility) &&
                 c.Metadata.Name == commandName &&
                 (c.Metadata.SubCommand == subCommandName || c.Metadata.SubCommand == null));
                 
diff --git a/src/SeqCli/Cli/CommandMetadata.cs b/src/SeqCli/Cli/CommandMetadata.cs
@@ -21,4 +21,5 @@ public class CommandMetadata : ICommandMetadata
     public required string HelpText { get; set; }
     public string? Example { get; set; }
     public FeatureVisibility Visibility { get; set; }
+    public SupportedPlatforms Platforms { get; set; }
 }
diff --git a/src/SeqCli/Cli/Commands/Forwarder/InstallCommand.cs b/src/SeqCli/Cli/Commands/Forwarder/InstallCommand.cs
@@ -15,6 +15,7 @@
 using System;
 using System.Diagnostics.CodeAnalysis;
 using System.IO;
+using System.Runtime.InteropServices;
 using System.Security.AccessControl;
 using System.Threading.Tasks;
 using SeqCli.Cli.Features;
@@ -27,7 +28,7 @@ namespace SeqCli.Cli.Commands.Forwarder;
 
 // ReSharper disable once ClassNeverInstantiated.Global
 
-[Command("forwarder", "install", "Install the forwarder as a Windows service", Visibility = FeatureVisibility.Preview)]
+[Command("forwarder", "install", "Install the forwarder as a Windows service", Visibility = FeatureVisibility.Preview, Platforms = SupportedPlatforms.Windows)]
 [SuppressMessage("Interoperability", "CA1416:Validate platform compatibility")]
 class InstallCommand : Command
 {
diff --git a/src/SeqCli/Cli/Commands/Forwarder/RestartCommand.cs b/src/SeqCli/Cli/Commands/Forwarder/RestartCommand.cs
@@ -22,7 +22,7 @@
 
 namespace SeqCli.Cli.Commands.Forwarder;
 
-[Command("forwarder", "restart", "Restart the forwarder Windows service", Visibility = FeatureVisibility.Preview)]
+[Command("forwarder", "restart", "Restart the forwarder Windows service", Visibility = FeatureVisibility.Preview, Platforms = SupportedPlatforms.Windows)]
 [SuppressMessage("Interoperability", "CA1416:Validate platform compatibility")]
 class RestartCommand : Command
 {
diff --git a/src/SeqCli/Cli/Commands/Forwarder/StartCommand.cs b/src/SeqCli/Cli/Commands/Forwarder/StartCommand.cs
@@ -20,7 +20,7 @@
 
 namespace SeqCli.Cli.Commands.Forwarder;
 
-[Command("forwarder", "start", "Start the forwarder Windows service", Visibility = FeatureVisibility.Preview)]
+[Command("forwarder", "start", "Start the forwarder Windows service", Visibility = FeatureVisibility.Preview, Platforms = SupportedPlatforms.Windows)]
 [SuppressMessage("Interoperability", "CA1416:Validate platform compatibility")]
 class StartCommand : Command
 {
diff --git a/src/SeqCli/Cli/Commands/Forwarder/StatusCommand.cs b/src/SeqCli/Cli/Commands/Forwarder/StatusCommand.cs
@@ -20,7 +20,7 @@
 
 namespace SeqCli.Cli.Commands.Forwarder;
 
-[Command("forwarder", "status", "Show the status of the forwarder Windows service", Visibility = FeatureVisibility.Preview)]
+[Command("forwarder", "status", "Show the status of the forwarder Windows service", Visibility = FeatureVisibility.Preview, Platforms = SupportedPlatforms.Windows)]
 [SuppressMessage("Interoperability", "CA1416:Validate platform compatibility")]
 class StatusCommand : Command
 {
diff --git a/src/SeqCli/Cli/Commands/Forwarder/StopCommand.cs b/src/SeqCli/Cli/Commands/Forwarder/StopCommand.cs
@@ -20,7 +20,7 @@
 
 namespace SeqCli.Cli.Commands.Forwarder;
 
-[Command("forwarder", "stop", "Stop the forwarder Windows service", Visibility = FeatureVisibility.Preview)]
+[Command("forwarder", "stop", "Stop the forwarder Windows service", Visibility = FeatureVisibility.Preview, Platforms = SupportedPlatforms.Windows)]
 [SuppressMessage("Interoperability", "CA1416:Validate platform compatibility")]
 class StopCommand : Command
 {
diff --git a/src/SeqCli/Cli/Commands/Forwarder/UninstallCommand.cs b/src/SeqCli/Cli/Commands/Forwarder/UninstallCommand.cs
@@ -20,7 +20,7 @@
 
 namespace SeqCli.Cli.Commands.Forwarder;
 
-[Command("forwarder", "uninstall", "Uninstall the forwarder Windows service", Visibility = FeatureVisibility.Preview)]
+[Command("forwarder", "uninstall", "Uninstall the forwarder Windows service", Visibility = FeatureVisibility.Preview, Platforms = SupportedPlatforms.Windows)]
 class UninstallCommand : Command
 {
     protected override Task<int> Run()
diff --git a/src/SeqCli/Cli/Commands/HelpCommand.cs b/src/SeqCli/Cli/Commands/HelpCommand.cs
@@ -16,6 +16,7 @@
 using System.Collections.Generic;
 using System.Linq;
 using System.Reflection;
+using System.Runtime.InteropServices;
 using System.Threading.Tasks;
 using Autofac.Features.Metadata;
 using CommandList = System.Collections.Generic.List<Autofac.Features.Metadata.Meta<System.Lazy<SeqCli.Cli.Command>, SeqCli.Cli.CommandMetadata>>;
@@ -25,10 +26,14 @@ namespace SeqCli.Cli.Commands;
 [Command("help", "Show information about available commands", Example = "seqcli help search")]
 class HelpCommand : Command
 {
+    readonly SupportedPlatforms _currentPlatform = RuntimeInformation.IsOSPlatform(OSPlatform.Windows)
+        ? SupportedPlatforms.Windows
+        : SupportedPlatforms.Unix;
+
     readonly IEnumerable<Meta<Lazy<Command>, CommandMetadata>> _allCommands;
     bool _markdown;
     FeatureVisibility _included = FeatureVisibility.Visible;
-
+    
     public HelpCommand(IEnumerable<Meta<Lazy<Command>, CommandMetadata>> allCommands)
     {
         _allCommands = allCommands.OrderBy(c => c.Metadata.Name).ToList();
@@ -38,12 +43,12 @@ public HelpCommand(IEnumerable<Meta<Lazy<Command>, CommandMetadata>> allCommands
         Options.Add("m|markdown", "Generate markdown for use in documentation", _ => _markdown = true);
     }
 
-    IEnumerable<Meta<Lazy<Command>, CommandMetadata>> AvailableCommands() =>
-        _allCommands.Where(c => _included.HasFlag(c.Metadata.Visibility));
+    IEnumerable<Meta<Lazy<Command>, CommandMetadata>> AvailableCommands(SupportedPlatforms platform, FeatureVisibility visibility) =>
+        _allCommands.Where(c => (c.Metadata.Platforms & platform) != SupportedPlatforms.None && visibility.HasFlag(c.Metadata.Visibility));
 
     protected override Task<int> Run(string[] unrecognized)
     {
-        var orderedCommands = AvailableCommands()
+        var orderedCommands = (_markdown ? AvailableCommands(SupportedPlatforms.All, FeatureVisibility.Visible | FeatureVisibility.Preview) : AvailableCommands(_currentPlatform, _included))
             .OrderBy(c => c.Metadata.Name)
             .ThenBy(c => c.Metadata.SubCommand)
             .ToList();
@@ -142,6 +147,23 @@ static void PrintMarkdownHelp(string executableName, CommandList orderedCommands
             else
                 Console.WriteLine($"### `{cmd.Metadata.Name}`");
             Console.WriteLine();
+            if (cmd.Metadata.Platforms != SupportedPlatforms.All ||
+                cmd.Metadata.Visibility == FeatureVisibility.Preview)
+            {
+                Console.Write(">");
+                if (cmd.Metadata.Visibility == FeatureVisibility.Preview)
+                {
+                    Console.Write(" Preview command: only available when the `--pre` command-line flag is specified.");
+                }
+
+                if (cmd.Metadata.Platforms != SupportedPlatforms.All)
+                {
+                    Console.Write($" This command is supported on **{cmd.Metadata.Platforms}** platforms only.");
+                }
+                Console.WriteLine();
+                Console.WriteLine();
+            }
+            
             Console.WriteLine(cmd.Metadata.HelpText + ".");
             Console.WriteLine();
 
diff --git a/src/SeqCli/Cli/SupportedPlatforms.cs b/src/SeqCli/Cli/SupportedPlatforms.cs
@@ -0,0 +1,12 @@
+using System;
+
+namespace SeqCli.Cli;
+
+[Flags]
+public enum SupportedPlatforms
+{
+    None,
+    Windows,
+    Unix,
+    All = Windows | Unix
+}

Original file line number	Diff line number	Diff line change
`@@ -24,16 +24,18 @@ public class CommandAttribute : Attribute, ICommandMetadata`
`24`	`24`	`public string HelpText { get; }`
`25`	`25`	`public string? Example { get; set; }`
`26`	`26`	`public FeatureVisibility Visibility { get; set; }`
	`27`	`+ public SupportedPlatforms Platforms { get; set; }`
`27`	`28`
`28`	`29`	`public CommandAttribute(string name, string helpText)`
`29`	`30`	`{`
`30`	`31`	`Name = name;`
`31`	`32`	`HelpText = helpText;`
`32`	`33`	`Visibility = FeatureVisibility.Visible;`
	`34`	`+ Platforms = SupportedPlatforms.All;`
`33`	`35`	`}`
`34`	`36`
`35`	`37`	`public CommandAttribute(string name, string subCommand, string helpText) : this(name, helpText)`
`36`	`38`	`{`
`37`	`39`	`SubCommand = subCommand;`
`38`	`40`	`}`
`39`		`-}`
	`41`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -21,4 +21,5 @@ public class CommandMetadata : ICommandMetadata`
`21`	`21`	`public required string HelpText { get; set; }`
`22`	`22`	`public string? Example { get; set; }`
`23`	`23`	`public FeatureVisibility Visibility { get; set; }`
	`24`	`+ public SupportedPlatforms Platforms { get; set; }`
`24`	`25`	`}`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@`
`22`	`22`
`23`	`23`	`namespace SeqCli.Cli.Commands.Forwarder;`
`24`	`24`
`25`		`-[Command("forwarder", "restart", "Restart the forwarder Windows service", Visibility = FeatureVisibility.Preview)]`
	`25`	`+[Command("forwarder", "restart", "Restart the forwarder Windows service", Visibility = FeatureVisibility.Preview, Platforms = SupportedPlatforms.Windows)]`
`26`	`26`	`[SuppressMessage("Interoperability", "CA1416:Validate platform compatibility")]`
`27`	`27`	`class RestartCommand : Command`
`28`	`28`	`{`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@`
`20`	`20`
`21`	`21`	`namespace SeqCli.Cli.Commands.Forwarder;`
`22`	`22`
`23`		`-[Command("forwarder", "start", "Start the forwarder Windows service", Visibility = FeatureVisibility.Preview)]`
	`23`	`+[Command("forwarder", "start", "Start the forwarder Windows service", Visibility = FeatureVisibility.Preview, Platforms = SupportedPlatforms.Windows)]`
`24`	`24`	`[SuppressMessage("Interoperability", "CA1416:Validate platform compatibility")]`
`25`	`25`	`class StartCommand : Command`
`26`	`26`	`{`