Skip to content

Module Reference / @tinystacks/ops-core-widgets / Cli

Interface: Cli

@tinystacks/ops-core-widgets.Cli

Example

EcsDiskUtil:
   type: Cli
   displayName: Show Disk Utils
   providers:
     - $ref: '#/Console/providers/AwsProvider'
   environmentVariables:
     AWS_REGION: $param.region
     CLUSTER_NAME: $param.clusterName
     CONTAINER_NAME:
       $ref: '#/Console/widgets/EcsInfo'
       path: images[0].containerId
   command: >
     aws ecs list-tasks --cluster $CLUSTER_NAME | jq '[.taskArns[0]][0]' | xargs -I{} bash -c 'aws ecs execute-command --cluster $CLUSTER_NAME --task {} --container $CONTAINER_NAME --command "df" --interactive';

Hierarchy

↳ Cli

Table of contents

Properties

Properties

additionalProperties

• Optional additionalProperties: any

Inherited from

Widget.additionalProperties

Defined in

node_modules/@tinystacks/ops-model/dist/models/Widget.d.ts:30

childrenIds

• Optional childrenIds: string[]

Inherited from

Widget.childrenIds

Defined in

node_modules/@tinystacks/ops-model/dist/models/Widget.d.ts:18

command

• command: string

Defined in

node_modules/@tinystacks/ops-core-widgets/dist/ops-types.d.ts:40

commandResult

• Optional commandResult: Object

Type declaration

Name Type
stderr string
stdout string

Defined in

node_modules/@tinystacks/ops-core-widgets/dist/ops-types.d.ts:41

description

• Optional description: string

Inherited from

Widget.description

Defined in

node_modules/@tinystacks/ops-model/dist/models/Widget.d.ts:19

displayName

• displayName: string

A human-readable display name, usually used to title a widget

Inherited from

Widget.displayName

Defined in

node_modules/@tinystacks/ops-model/dist/models/Widget.d.ts:12

displayOptions

• Optional displayOptions: Object

Type declaration

Name Type Description
showDescription? boolean Whether to show the description
showDisplayName? boolean Whether to show the display name

Inherited from

Widget.displayOptions

Defined in

node_modules/@tinystacks/ops-model/dist/models/Widget.d.ts:20

environmentVariables

• Optional environmentVariables: Object

Index signature

▪ [key: string]: string

Defined in

node_modules/@tinystacks/ops-core-widgets/dist/ops-types.d.ts:47

hasRun

• Optional hasRun: boolean

Defined in

node_modules/@tinystacks/ops-core-widgets/dist/ops-types.d.ts:46

id

• id: string

Unique Id for this widget.

Inherited from

Widget.id

Defined in

node_modules/@tinystacks/ops-model/dist/models/Widget.d.ts:8

providerIds

• Optional providerIds: string[]

Inherited from

Widget.providerIds

Defined in

node_modules/@tinystacks/ops-model/dist/models/Widget.d.ts:17

runOnStart

• Optional runOnStart: boolean

Defined in

node_modules/@tinystacks/ops-core-widgets/dist/ops-types.d.ts:45

type

• type: string

This describes how this widget should be rendered. The "type" should be equivalent to the Object definition's name of the widget you are trying to render.

Inherited from

Widget.type

Defined in

node_modules/@tinystacks/ops-model/dist/models/Widget.d.ts:16