Class AddSSHKeys

The AddSSHKeys command is a special step that adds SSH keys from a project’s settings to a container. Also configures SSH to use these keys.

see: https://circleci.com/docs/configuration-reference#add-ssh-keys

Hierarchy

AddSSHKeys

Implements

Command

Index

Constructors

constructor

Properties

parameters

Accessors

Methods

generate

Constructors

constructor

new AddSSHKeys(parameters: AddSSHKeysParameters): AddSSHKeys

- Defined in src/lib/Components/Commands/exports/Native/AddSSHKeys.ts:12
Parameters
- parameters: AddSSHKeysParameters
Returns AddSSHKeys

Properties

parameters

parameters: AddSSHKeysParameters

Step parameters

Accessors

generableType

get generableType(): GenerableType

Implementation of Command.generableType
- Defined in src/lib/Components/Commands/exports/Native/AddSSHKeys.ts:29
Type of generable object

Returns GenerableType

name

get name(): string

Implementation of Command.name
- Defined in src/lib/Components/Commands/exports/Native/AddSSHKeys.ts:25
The name of the CircleCI step, which will appear in the CircleCI UI.

Returns string

Methods

generate

generate(): AddSSHKeysCommandShape

Implementation of Command.generate
- Defined in src/lib/Components/Commands/exports/Native/AddSSHKeys.ts:19
Generate AddSSHKeys Command shape.

Returns AddSSHKeysCommandShape
The generated JSON for the AddSSHKeys Command.

Generated using TypeDoc