HostCredential

Parameters and properties

• sourceRequired
  HostCredentialPath
  Host location of the credential file and the optional environment variable that relocates the CLI’s home.
• destinationRequired
  { readonly file: string; } | { readonly variable: string; }
  Where the selected content goes: a file path relative to the sandbox home, or an environment variable.
• loginRequired
  string
  Host command that creates the file, shown when it is missing.
• alternativeOptional
  string | undefined
  Alternative authentication form suggested when the file is missing.
• selectOptional
  ((content: string) => string) | undefined
  Validate the file and return only the content to install or forward, without echoing secrets in errors.

Signature

export interface HostCredential {
  readonly source: HostCredentialPath;
  readonly destination:
    | {
        readonly file: string;
      }
    | {
        readonly variable: string;
      };
  readonly login: string;
  readonly alternative?: string;
  select?(content: string): string;
}

Related contracts

• HostCredentialPath