Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ISaveProfileFromCliArgs

Parameters for creating a profile from command line arguments - normally invoked from a command handler that is pre-built by imperative.

export
interface

ICreateProfileFromArgs

Hierarchy

Index

Properties

Optional args

args: Arguments

The Yargs style arguments - supplied from the command invocation.

memberof

ISaveProfileFromCliArgs

Optional disableDefaults

disableDefaults: boolean

The argument to disable populating defaults

memberof

ISaveProfileFromCliArgs

name

name: string

The name of the profile to save

memberof

ISaveProfile

Optional overwrite

overwrite: boolean

Set to true to overwrite an existing profile of the same name. If false, an error is thrown if the profile already exists.

memberof

ISaveProfile

profile

profile: IProfile

The profile contents - must extend the IProfile interface to function properly with Imperative. The contents are always validated against the schema documents (and basic validation occurs)

memberof

ISaveProfile

type

type: string

The type of profile to save

memberof

ISaveProfile

Optional updateDefault

updateDefault: boolean

Set to true to update the default profile for the profile type.

memberof

ISaveProfile

Generated using TypeDoc