Skip to content

RemoteParameter

A portable description of a command argument or option.

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

RemoteParameter(string, string, bool, string?, JsonElement, IReadOnlyList<string>)

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

A portable description of a command argument or option.

public RemoteParameter(string Name, string Kind, bool Required, string? Description, JsonElement Schema, IReadOnlyList<string> Aliases)
  • Name (string): Canonical invocation key.
  • Kind (string): Either argument or option.
  • Required (bool): Whether a value is required.
  • Description (string): User-facing help.
  • Schema (JsonElement): JSON Schema Draft 7 describing the value.
  • Aliases (IReadOnlyList<string>): CLI aliases for this parameter.

CLI aliases for this parameter.

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

IReadOnlyList<string>

User-facing help.

public string? Description { get; init; }

string

Either argument or option.

public string Kind { get; init; }

string

Canonical invocation key.

public string Name { get; init; }

string

Whether a value is required.

public bool Required { get; init; }

bool

JSON Schema Draft 7 describing the value.

public JsonElement Schema { get; init; }

JsonElement