Skip to content

RemoteCommand

A command’s canonical identity and discoverable parameters.

public sealed record RemoteCommand : IEquatable<RemoteCommand>
  • IEquatable<RemoteCommand>

RemoteCommand(string, string?, IReadOnlyList<string>, IReadOnlyList<RemoteParameter>)

Section titled “RemoteCommand(string, string?, IReadOnlyList<string>, IReadOnlyList<RemoteParameter>)”

A command’s canonical identity and discoverable parameters.

public RemoteCommand(string Path, string? Description, IReadOnlyList<string> Aliases, IReadOnlyList<RemoteParameter> Parameters)
  • Path (string): Registered route template.
  • Description (string): User-facing description.
  • Aliases (IReadOnlyList<string>): CLI aliases.
  • Parameters (IReadOnlyList<RemoteParameter>): Arguments and options in declaration order.

CLI aliases.

public IReadOnlyList<string> Aliases { get; init; }

IReadOnlyList<string>

User-facing description.

public string? Description { get; init; }

string

Arguments and options in declaration order.

public IReadOnlyList<RemoteParameter> Parameters { get; init; }

IReadOnlyList<RemoteParameter>

Registered route template.

public string Path { get; init; }

string