@stedi/cli

cli

Stedi CLI

• Usage
• Commands

Usage

$ npm install -g @stedi/cli
$ stedi COMMAND
running command...
$ stedi (-v|--version|version)
@stedi/cli/1.21.3 linux-x64 node-v14.17.5
$ stedi --help [COMMAND]
USAGE
  $ stedi COMMAND
...

Commands

• stedi cicd:cdk-deploy PATH
• stedi cicd:delete
• stedi cicd:deploy PATH
• stedi cicd:describe
• stedi cicd:generate-template
• stedi cicd:get-package
• stedi cicd:list
• stedi cicd:package PATH
• stedi help [COMMAND]
• stedi resources:delete
• stedi resources:describe
• stedi resources:list

stedi cicd:cdk-deploy PATH

Deploy a cdk resource set using infrastructure as code.

USAGE
  $ stedi cicd:cdk-deploy PATH

ARGUMENTS
  PATH  path to the CDK application folder

OPTIONS
  -a, --api-key=api-key  API Key used for Authentication, defaults to STEDI_API_KEY environment variable or api-key
                         attribute from .stedirc file.

  -f, --force            force update of resources

  -n, --name=name        (required) name of the resource set to update/create

  -o, --output=output    preserve intermediary templates from CDK and place them into provided output directory

  -v, --verbose          when set to true will output additional logs to the cli output

  --skip-validation      skip strict validation of resources (this option will be removed soon)

See code: src/commands/cicd/cdk-deploy.ts

stedi cicd:delete

Delete a resource set and its associated resources.

USAGE
  $ stedi cicd:delete

OPTIONS
  -a, --api-key=api-key  API Key used for Authentication, defaults to STEDI_API_KEY environment variable or api-key
                         attribute from .stedirc file.

  -n, --name=name        (required) name of the resource set to update/create

  -v, --verbose          when set to true will output additional logs to the cli output

See code: src/commands/cicd/delete.ts

stedi cicd:deploy PATH

Deploy a resource set using infrastructure as code.

USAGE
  $ stedi cicd:deploy PATH

ARGUMENTS
  PATH  path to the Stedi Form template file

OPTIONS
  -a, --api-key=api-key        API Key used for Authentication, defaults to STEDI_API_KEY environment variable or
                               api-key attribute from .stedirc file.

  -f, --force                  force update of resources

  -n, --name=name              (required) name of the resource set to update/create

  -o, --output=output          preserve package templates and place them into provided output directory

  -p, --parameters=parameters  parameters to be passed to resource set

  -v, --verbose                when set to true will output additional logs to the cli output

  --skip-validation            skip strict validation of resources (this option will be removed soon)

See code: src/commands/cicd/deploy.ts

stedi cicd:describe

Print information about a previously deployed resource set.

USAGE
  $ stedi cicd:describe

OPTIONS
  -a, --api-key=api-key  API Key used for Authentication, defaults to STEDI_API_KEY environment variable or api-key
                         attribute from .stedirc file.

  -n, --name=name        (required) name of the resource set to update/create

  -v, --verbose          when set to true will output additional logs to the cli output

See code: src/commands/cicd/describe.ts

stedi cicd:generate-template

Creates a formation template for a resources, either managed by formation or unmanaged.

USAGE
  $ stedi cicd:generate-template

OPTIONS
  -a, --api-key=api-key  API Key used for Authentication, defaults to STEDI_API_KEY environment variable or api-key
                         attribute from .stedirc file.

  -f, --format=format    [default: yaml] format of the template that is generated.

  -i, --id=id            (required) id of the resource to create the template for.

  -t, --type=type        (required) type of the resource to create the template for.

  -v, --verbose          when set to true will output additional logs to the cli output

See code: src/commands/cicd/generate-template.ts

stedi cicd:get-package

Downloads the JSON package last used to deploy a resource.

USAGE
  $ stedi cicd:get-package

OPTIONS
  -a, --api-key=api-key  API Key used for Authentication, defaults to STEDI_API_KEY environment variable or api-key
                         attribute from .stedirc file.

  -n, --name=name        (required) name of the resource set

  -v, --verbose          when set to true will output additional logs to the cli output

See code: src/commands/cicd/get-package.ts

stedi cicd:list

List all deployed resource set.

USAGE
  $ stedi cicd:list

OPTIONS
  -a, --api-key=api-key  API Key used for Authentication, defaults to STEDI_API_KEY environment variable or api-key
                         attribute from .stedirc file.

  -v, --verbose          when set to true will output additional logs to the cli output

See code: src/commands/cicd/list.ts

stedi cicd:package PATH

Package an infrastructure as code model as a single JSON file that can be distributed and uploaded.

USAGE
  $ stedi cicd:package PATH

ARGUMENTS
  PATH  path to the Stedi Form template input

See code: src/commands/cicd/package.ts

stedi help [COMMAND]

display help for stedi

USAGE
  $ stedi help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

stedi resources:delete

Deletes a resource from your stedi account.

USAGE
  $ stedi resources:delete

OPTIONS
  -a, --api-key=api-key  API Key used for Authentication, defaults to STEDI_API_KEY environment variable or api-key
                         attribute from .stedirc file.

  -i, --id=id            (required) id of the resource to delete

  -t, --type=type        (required) type of the resource to delete

  -v, --verbose          when set to true will output additional logs to the cli output

See code: src/commands/resources/delete.ts

stedi resources:describe

Describe a resource from your stedi account.

USAGE
  $ stedi resources:describe

OPTIONS
  -a, --api-key=api-key  API Key used for Authentication, defaults to STEDI_API_KEY environment variable or api-key
                         attribute from .stedirc file.

  -f, --idField=idField  id field used to query the resource

  -i, --id=id            (required) id of the resource to describe

  -t, --type=type        (required) type of the resource to describe

  -v, --verbose          when set to true will output additional logs to the cli output

See code: src/commands/resources/describe.ts

stedi resources:list

List resources from your stedi account.

USAGE
  $ stedi resources:list

OPTIONS
  -a, --api-key=api-key  API Key used for Authentication, defaults to STEDI_API_KEY environment variable or api-key
                         attribute from .stedirc file.

  -t, --type=type        (required) type of the resources to list

  -v, --verbose          when set to true will output additional logs to the cli output

See code: src/commands/resources/list.ts