ChocoSearchOptions.Generated.cs

// <auto-generated>
// This file was generated by ModularPipelines.OptionsGenerator.
// Do not edit this file manually.
// </auto-generated>

#nullable enable

using System.CodeDom.Compiler;
using System.Diagnostics.CodeAnalysis;
using ModularPipelines.Attributes;
using ModularPipelines.Chocolatey.Options;

namespace ModularPipelines.Chocolatey.Options;

/// <summary>
/// NOTE: See scripting in the command reference (`choco --help`) for how to
/// </summary>
[GeneratedCode("ModularPipelines.OptionsGenerator", "")]
[ExcludeFromCodeCoverage]
[CliSubCommand("search")]
public record ChocoSearchOptions : ChocoOptions
{
    /// <summary>
    /// Online - Open help for specified command in default browser application. This option only works when used in combination with the -?/--help/-h option.  Available in 2.0.0+
    /// </summary>
    [CliFlag("--online")]
    public bool? Online { get; set; }

    /// <summary>
    /// Debug - Show debug messaging.
    /// </summary>
    [CliFlag("--debug", ShortForm = "-d")]
    public bool? Debug { get; set; }

    /// <summary>
    /// Verbose - Show verbose messaging. Very verbose messaging, avoid using under normal circumstances.
    /// </summary>
    [CliFlag("--verbose", ShortForm = "-v")]
    public bool? Verbose { get; set; }

    /// <summary>
    /// Trace - Show trace messaging. Very, very verbose trace messaging. Avoid except when needing super low-level .NET Framework debugging.
    /// </summary>
    [CliFlag("--trace")]
    public bool? Trace { get; set; }

    /// <summary>
    /// Force - force the behavior. Do not use force during normal operation - it subverts some of the smart behavior for commands.
    /// </summary>
    [CliFlag("--force", ShortForm = "-f")]
    public bool? Force { get; set; }

    /// <summary>
    /// Include header names when --limit-output is used. Requires Chocolatey CLI 2.5.0+
    /// </summary>
    [CliFlag("--include-headers")]
    public bool? IncludeHeaders { get; set; }

    /// <summary>
    /// UseSystemPowerShell - Execute PowerShell using an external process instead of the built-in PowerShell host. Should only be used when internal host is failing.
    /// </summary>
    [CliFlag("--use-system-powershell")]
    public bool? UseSystemPowershell { get; set; }

    /// <summary>
    /// Do Not Show Progress - Do not show download progress percentages.
    /// </summary>
    [CliFlag("--no-progress")]
    public bool? NoProgress { get; set; }

    /// <summary>
    /// Proxy Location - Explicit proxy location. Overrides the default proxy location of ''.
    /// </summary>
    [CliOption("--proxy", Format = OptionFormat.EqualsSeparated)]
    public string? Proxy { get; set; }

    /// <summary>
    /// Proxy User Name - Explicit proxy user (optional). Requires explicit proxy (`--proxy` or config setting). Overrides the default proxy user of ''.
    /// </summary>
    [CliOption("--proxy-user", Format = OptionFormat.EqualsSeparated)]
    public string? ProxyUser { get; set; }

    /// <summary>
    /// Proxy Password - Explicit proxy password (optional) to be used with user name. Encrypted. Requires explicit proxy (`--proxy` or config setting) and user name (`--proxy-user` or config setting).  Overrides the default proxy password.
    /// </summary>
    [SecretValue]
    [CliOption("--proxy-password", Format = OptionFormat.EqualsSeparated)]
    public string? ProxyPassword { get; set; }

    /// <summary>
    /// ProxyBypassList - Comma separated list of regex locations to bypass on proxy. Requires explicit proxy (`--proxy` or config setting). Overrides the default proxy bypass list of ''.
    /// </summary>
    [CliOption("--proxy-bypass-list", Format = OptionFormat.EqualsSeparated)]
    public string? ProxyBypassList { get; set; }

    /// <summary>
    /// Proxy Bypass On Local - Bypass proxy for local connections. Requires explicit proxy (`--proxy` or config setting). Overrides the default proxy bypass on local setting of 'True'.
    /// </summary>
    [CliFlag("--proxy-bypass-on-local")]
    public bool? ProxyBypassOnLocal { get; set; }

    /// <summary>
    /// Log File to output to in addition to regular loggers.
    /// </summary>
    [CliOption("--log-file", Format = OptionFormat.EqualsSeparated)]
    public string? LogFile { get; set; }

    /// <summary>
    /// Ignore any HTTP caches that have previously been created when querying sources, and create new caches. Available in 2.1.0+
    /// </summary>
    [CliFlag("--ignore-http-cache")]
    public bool? IgnoreHttpCache { get; set; }

    /// <summary>
    /// Source - Source location for install. Can use special 'windowsfeatures', 'ruby', 'cygwin', or 'python' sources. Defaults to sources.
    /// </summary>
    [CliOption("--source", ShortForm = "-s", Format = OptionFormat.EqualsSeparated)]
    public string? Source { get; set; }

    /// <summary>
    /// Version - Specific version of a package to return.
    /// </summary>
    [CliOption("--version", Format = OptionFormat.EqualsSeparated)]
    public string? Version { get; set; }

    /// <summary>
    /// User - used with authenticated feeds. Defaults to empty.
    /// </summary>
    [CliOption("--user", ShortForm = "-u", Format = OptionFormat.EqualsSeparated)]
    public string? User { get; set; }

    /// <summary>
    /// Password - the user's password to the source. Defaults to empty.
    /// </summary>
    [SecretValue]
    [CliOption("--password", ShortForm = "-p", Format = OptionFormat.EqualsSeparated)]
    public string? Password { get; set; }

    /// <summary>
    /// Client certificate - PFX pathname for an x509 authenticated feeds. Defaults to empty.
    /// </summary>
    [CliOption("--cert", Format = OptionFormat.EqualsSeparated)]
    public string? Cert { get; set; }

    /// <summary>
    /// Page - the 'page' of results to return. Defaults to return all results.
    /// </summary>
    [CliOption("--page", Format = OptionFormat.EqualsSeparated)]
    public string? Page { get; set; }

    /// <summary>
    /// Page Size - the amount of packages to return in each page of results. NOTE: this value is per source. Defaults to 25 for each source that is included in query.
    /// </summary>
    [CliOption("--page-size", Format = OptionFormat.EqualsSeparated)]
    public string? PageSize { get; set; }

    /// <summary>
    /// Exact - Only return packages with this exact name.
    /// </summary>
    [CliFlag("--exact", ShortForm = "-e")]
    public bool? Exact { get; set; }

    /// <summary>
    /// ByIdOnly - Only return packages where the id contains the search filter.
    /// </summary>
    [CliFlag("--by-id-only")]
    public bool? ByIdOnly { get; set; }

    /// <summary>
    /// IdStartsWith - Only return packages where the id starts with the search filter.
    /// </summary>
    [CliFlag("--id-starts-with")]
    public bool? IdStartsWith { get; set; }

    /// <summary>
    /// OrderBy - Sort package results by Id (default), Title, Popularity, LastPublished, Unsorted. Available in 2.5.0+.
    /// </summary>
    [CliOption("--order-by", Format = OptionFormat.EqualsSeparated)]
    public string? OrderBy { get; set; }

    /// <summary>
    /// (Deprecated) OrderByPopularity - Sort package results by popularity. Use '--order-by='Popularity'' instead.
    /// </summary>
    [CliFlag("--order-by-popularity")]
    public bool? OrderByPopularity { get; set; }

    /// <summary>
    /// ApprovedOnly - Only return approved packages - this option will filter out results not from the community repository.
    /// </summary>
    [CliFlag("--approved-only")]
    public bool? ApprovedOnly { get; set; }

    /// <summary>
    /// NotBroken - Only return packages that are not failing testing - this option only filters out failing results from the community feed. It will not filter against other sources.
    /// </summary>
    [CliFlag("--not-broken")]
    public bool? NotBroken { get; set; }

    /// <summary>
    /// Include Configured Sources - When using the '--source' option, this appends the sources that have been saved into the chocolatey.config file by 'source' command.  Available in 2.3.0+
    /// </summary>
    [CliFlag("--include-configured-sources")]
    public bool? IncludeConfiguredSources { get; set; }

}