package
6.33.0+incompatible
Repository: https://github.com/loggregator/cli.git
Documentation: pkg.go.dev
# Functions
ConfigFilePath returns the location of the config file.
LoadConfig loads the config from the .cf/config.json and os.ENV.
WriteConfig creates the .cf directory and then writes the config.json.
# Constants
ColorAuto means that the UI should decide if colors/bolding will be enabled.
ColorDisabled means that no colors/bolding will be displayed.
ColorEnabled means colors/bolding will be displayed.
DefaultColorEnabled is the default CFConfig value for ColorEnabled.
DefaultDialTimeout is the default timeout for the dail.
DefaultLocale is the default CFConfig value for Locale.
DefaultOverallPollingTimeout is the default maximum time that the CLI will poll a job running on the Cloud Controller.
DefaultPluginRepoName is the name of the preinstalled plugin repository.
DefaultPluginRepoURL is the URL of the preinstalled plugin repository.
DefaultPollingInterval is the time between consecutive polls of a status.
DefaultSSHOAuthClient is the default oauth client ID for SSHing into an application/process container.
DefaultStagingTimeout is the default timeout for application staging.
DefaultStartupTimeout is the default timeout for application starting.
DefaultTarget is the default CFConfig value for Target.
DefaultUAAOAuthClient is the default client ID for the CLI when communicating with the UAA.
DefaultUAAOAuthClientSecret is the default client secret for the CLI when communicating with the UAA.
# Structs
CFConfig represents .cf/config.json.
Config combines the settings taken from the .cf/config.json, os.ENV, and the plugin config.
EnvOverride represents all the environment variables read by the CF CLI.
FlagOverride represents all the global flags passed to the CF CLI.
Organization contains basic information about the targeted organization.
Plugin represents the plugin as a whole, not be confused with PluginCommand.
PluginCommand represents an individual command inside a plugin.
PluginRepository is a saved plugin repository.
PluginsConfig represents the plugin configuration.
PluginUsageDetails contains the usage metadata provided by the plugin.
PluginVersion is the plugin version information.
QuotaDefinition contains information about the organization's quota.
Space contains basic information about the targeted space.
User represents the user information provided by the JWT access token.
# Type aliases
ColorSetting is a trinary operator that represents if the display should have colors enabled, disabled, or automatically detected.