A required org, specified by username or alias Will throw if the specified org default do not exist Will default to the default org if one is not specified. Will throw if no default org exists and none is specified

import { Flags } from '@salesforce/sf-plugins-core';
public static flags = {
// setting length or prefix
'target-org': Flags.requiredOrg(),
// adding properties
'flag2': Flags.requiredOrg({
required: true,
description: 'flag2 description',
char: 'o'
}),
}
  • Parameters

    • options: CustomOptions & {} & Partial<OptionFlag<Org, CustomOptions>>

    Returns OptionFlag<Org, CustomOptions>

  • Parameters

    • options: CustomOptions & {} & Partial<OptionFlag<undefined | Org[], CustomOptions>>

    Returns OptionFlag<undefined | Org[], CustomOptions>

  • Parameters

    • options: CustomOptions & {} & Partial<OptionFlag<undefined | Org, CustomOptions>>

    Returns OptionFlag<undefined | Org, CustomOptions>

  • Parameters

    • options: CustomOptions & {} & (({ required: true; } | { default: FlagDefault<Org | undefined, CustomOptions>; }) & Partial<OptionFlag<Org, CustomOptions>>)

    Returns OptionFlag<Org, CustomOptions>

  • Parameters

    • options: CustomOptions & {} & (({ required: true; } | { default: FlagDefault<Org[] | undefined, CustomOptions>; }) & Partial<OptionFlag<Org[], CustomOptions>>)

    Returns OptionFlag<Org[], CustomOptions>

  • Parameters

    • options: CustomOptions & {} & (({ required: true; } | { default: FlagDefault<Org | undefined, CustomOptions>; }) & Partial<OptionFlag<Org, CustomOptions>>)

    Returns OptionFlag<Org, CustomOptions>

  • Parameters

    • options: CustomOptions & {} & Partial<OptionFlag<undefined | Org, CustomOptions>>

    Returns OptionFlag<undefined | Org, CustomOptions>

  • Parameters

    • options: CustomOptions & {} & Partial<OptionFlag<Org, CustomOptions>>

    Returns OptionFlag<Org, CustomOptions>

  • Parameters

    • Optionaloptions: CustomOptions & {} & Partial<OptionFlag<Org, CustomOptions>>

    Returns OptionFlag<Org, CustomOptions>

  • Parameters

    • options: CustomOptions & {} & Partial<OptionFlag<Org[], CustomOptions>>

    Returns OptionFlag<Org[], CustomOptions>