@stedi/cli

v3.14.7

Published

7 days ago

stedi cli

Downloads

382

0High
0Medium
0Low

stediengineering

stedi-cli

Stedi CLI enables you to easily work with Stedi's APIs and services from the command line. Learn more: https://www.stedi.com/docs.

Usage

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

Stability

Expect patches and features, possible API changes.

Commands

`stedi as2 create-agreement`

Creates a Stedi AS2 agreement.

USAGE
  $ stedi as2 create-agreement -n <value> --server-id <value> --local-profile-id <value> --partner-profile-id <value>
    --base-directory <value> --status ACTIVE|INACTIVE [-a <value>] [-v] [--description <value>]

FLAGS
  -a, --api-key=<value>             API Key used for Authentication, defaults to STEDI_API_KEY environment variable or
                                    api-key attribute from .stedirc file.
  -n, --name=<value>                (required) AS2 agreement name
  -v, --verbose                     when set to true will output additional logs to the cli output
      --base-directory=<value>      (required) Stedi bucket base directory
      --description=<value>         AS2 agreement description. Note that only alphanumeric characters, dashes, and
                                    underscores are allowed.
      --local-profile-id=<value>    (required) AS2 local profile id
      --partner-profile-id=<value>  (required) AS2 partner profile id
      --server-id=<value>           (required) AS2 Server Id
      --status=<option>             (required) AS2 agreement status
                                    <options: ACTIVE|INACTIVE>

DESCRIPTION
  Creates a Stedi AS2 agreement.

See code: src/commands/as2/create-agreement.ts

`stedi as2 create-connector`

Creates a Stedi AS2 connector.

USAGE
  $ stedi as2 create-connector -n <value> --url <value> --local-profile-id <value> --partner-profile-id <value> [-a
    <value>] [-v] [--compression ZLIB|DISABLED] [--message-subject <value>] [--encryption-algorithm
    AES128_CBC|AES192_CBC|AES256_CBC] [--signing-algorithm SHA256|SHA384|SHA512|SHA1|NONE] [--mdn-signing-algorithm
    SHA256|SHA384|SHA512|SHA1|NONE|DEFAULT] [--mdn-response SYNC|NONE]

FLAGS
  -a, --api-key=<value>                 API Key used for Authentication, defaults to STEDI_API_KEY environment variable
                                        or api-key attribute from .stedirc file.
  -n, --name=<value>                    (required) AS2 connector name
  -v, --verbose                         when set to true will output additional logs to the cli output
      --compression=<option>            Compression algorithm, can be ZLIB or DISABLED
                                        <options: ZLIB|DISABLED>
      --encryption-algorithm=<option>   The algorithm that is used to encrypt the file. Valid values: AES128_CBC |
                                        AES192_CBC | AES256_CBC.
                                        <options: AES128_CBC|AES192_CBC|AES256_CBC>
      --local-profile-id=<value>        (required) AS2 local profile id
      --mdn-response=<option>           Specify if MDN response is required.
                                        <options: SYNC|NONE>
      --mdn-signing-algorithm=<option>  The signing algorithm for the MDN response. Valid values: SHA256 | SHA384 |
                                        SHA512 | SHA1 | NONE | DEFAULT (DEFAULT = use same algorithm as
                                        signing-algorithm).
                                        <options: SHA256|SHA384|SHA512|SHA1|NONE|DEFAULT>
      --message-subject=<value>         Used as the Subject HTTP header attribute in AS2 messages that are being sent
                                        with the connector.
      --partner-profile-id=<value>      (required) AS2 partner profile id
      --signing-algorithm=<option>      The algorithm that is used to sign the AS2 messages sent with the connector.
                                        Valid values: SHA256 | SHA384 | SHA512 | SHA1 | NONE.
                                        <options: SHA256|SHA384|SHA512|SHA1|NONE>
      --url=<value>                     (required) AS2 Partner URL

DESCRIPTION
  Creates a Stedi AS2 connector.

See code: src/commands/as2/create-connector.ts

`stedi as2 create-profile`

Creates a Stedi AS2 profile.

USAGE
  $ stedi as2 create-profile -n <value> --as2-id <value> --profile-type LOCAL|PARTNER --certificate-ids <value> [-a
    <value>] [-v]

FLAGS
  -a, --api-key=<value>          API Key used for Authentication, defaults to STEDI_API_KEY environment variable or
                                 api-key attribute from .stedirc file.
  -n, --name=<value>             (required) AS2 server name
  -v, --verbose                  when set to true will output additional logs to the cli output
      --as2-id=<value>           (required) AS2 Id
      --certificate-ids=<value>  (required) Comma separated string of certificate ids
      --profile-type=<option>    (required) AS2 profile type
                                 <options: LOCAL|PARTNER>

DESCRIPTION
  Creates a Stedi AS2 profile.

See code: src/commands/as2/create-profile.ts

`stedi as2 create-server`

Creates a Stedi AS2 server.

USAGE
  $ stedi as2 create-server -n <value> [-a <value>] [-v]

FLAGS
  -a, --api-key=<value>  API Key used for Authentication, defaults to STEDI_API_KEY environment variable or api-key
                         attribute from .stedirc file.
  -n, --name=<value>     (required) AS2 server name
  -v, --verbose          when set to true will output additional logs to the cli output

DESCRIPTION
  Creates a Stedi AS2 server.

See code: src/commands/as2/create-server.ts

`stedi as2 delete-agreement`

Delete a Stedi AS2 agreement.

USAGE
  $ stedi as2 delete-agreement -n <value> [-a <value>] [-v]

FLAGS
  -a, --api-key=<value>  API Key used for Authentication, defaults to STEDI_API_KEY environment variable or api-key
                         attribute from .stedirc file.
  -n, --name=<value>     (required) AS2 server name
  -v, --verbose          when set to true will output additional logs to the cli output

DESCRIPTION
  Delete a Stedi AS2 agreement.

See code: src/commands/as2/delete-agreement.ts

`stedi as2 delete-certificate`

Delete a Stedi AS2 certificate.

USAGE
  $ stedi as2 delete-certificate -n <value> [-a <value>] [-v]

FLAGS
  -a, --api-key=<value>  API Key used for Authentication, defaults to STEDI_API_KEY environment variable or api-key
                         attribute from .stedirc file.
  -n, --name=<value>     (required) AS2 server name
  -v, --verbose          when set to true will output additional logs to the cli output

DESCRIPTION
  Delete a Stedi AS2 certificate.

See code: src/commands/as2/delete-certificate.ts

`stedi as2 delete-connector`

Delete a Stedi AS2 connector.

USAGE
  $ stedi as2 delete-connector -n <value> [-a <value>] [-v]

FLAGS
  -a, --api-key=<value>  API Key used for Authentication, defaults to STEDI_API_KEY environment variable or api-key
                         attribute from .stedirc file.
  -n, --name=<value>     (required) AS2 connector name
  -v, --verbose          when set to true will output additional logs to the cli output

DESCRIPTION
  Delete a Stedi AS2 connector.

See code: src/commands/as2/delete-connector.ts

`stedi as2 delete-profile`

Creates a Stedi AS2 profile.

USAGE
  $ stedi as2 delete-profile -n <value> [-a <value>] [-v]

FLAGS
  -a, --api-key=<value>  API Key used for Authentication, defaults to STEDI_API_KEY environment variable or api-key
                         attribute from .stedirc file.
  -n, --name=<value>     (required) AS2 server name
  -v, --verbose          when set to true will output additional logs to the cli output

DESCRIPTION
  Creates a Stedi AS2 profile.

See code: src/commands/as2/delete-profile.ts

`stedi as2 delete-server`

Delete a Stedi AS2 server.

USAGE
  $ stedi as2 delete-server -n <value> [-a <value>] [-v]

FLAGS
  -a, --api-key=<value>  API Key used for Authentication, defaults to STEDI_API_KEY environment variable or api-key
                         attribute from .stedirc file.
  -n, --name=<value>     (required) AS2 server name
  -v, --verbose          when set to true will output additional logs to the cli output

DESCRIPTION
  Delete a Stedi AS2 server.

See code: src/commands/as2/delete-server.ts

`stedi as2 describe-agreement`

Describe a Stedi AS2 agreement.

USAGE
  $ stedi as2 describe-agreement -n <value> [-a <value>] [-v]

FLAGS
  -a, --api-key=<value>  API Key used for Authentication, defaults to STEDI_API_KEY environment variable or api-key
                         attribute from .stedirc file.
  -n, --name=<value>     (required) AS2 agreement name
  -v, --verbose          when set to true will output additional logs to the cli output

DESCRIPTION
  Describe a Stedi AS2 agreement.

See code: src/commands/as2/describe-agreement.ts

`stedi as2 describe-certificate`

Describe a Stedi AS2 certificate.

USAGE
  $ stedi as2 describe-certificate -n <value> [-a <value>] [-v]

FLAGS
  -a, --api-key=<value>  API Key used for Authentication, defaults to STEDI_API_KEY environment variable or api-key
                         attribute from .stedirc file.
  -n, --name=<value>     (required) AS2 certificate name
  -v, --verbose          when set to true will output additional logs to the cli output

DESCRIPTION
  Describe a Stedi AS2 certificate.

See code: src/commands/as2/describe-certificate.ts

`stedi as2 describe-connector`

Describe a Stedi AS2 connector.

USAGE
  $ stedi as2 describe-connector -n <value> [-a <value>] [-v]

FLAGS
  -a, --api-key=<value>  API Key used for Authentication, defaults to STEDI_API_KEY environment variable or api-key
                         attribute from .stedirc file.
  -n, --name=<value>     (required) AS2 agreement name
  -v, --verbose          when set to true will output additional logs to the cli output

DESCRIPTION
  Describe a Stedi AS2 connector.

See code: src/commands/as2/describe-connector.ts

`stedi as2 describe-profile`

Describe a Stedi AS2 profile.

USAGE
  $ stedi as2 describe-profile -n <value> [-a <value>] [-v]

FLAGS
  -a, --api-key=<value>  API Key used for Authentication, defaults to STEDI_API_KEY environment variable or api-key
                         attribute from .stedirc file.
  -n, --name=<value>     (required) AS2 profile name
  -v, --verbose          when set to true will output additional logs to the cli output

DESCRIPTION
  Describe a Stedi AS2 profile.

See code: src/commands/as2/describe-profile.ts

`stedi as2 describe-server`

Describe a Stedi AS2 server.

USAGE
  $ stedi as2 describe-server -n <value> [-a <value>] [-v]

FLAGS
  -a, --api-key=<value>  API Key used for Authentication, defaults to STEDI_API_KEY environment variable or api-key
                         attribute from .stedirc file.
  -n, --name=<value>     (required) AS2 server name
  -v, --verbose          when set to true will output additional logs to the cli output

DESCRIPTION
  Describe a Stedi AS2 server.

See code: src/commands/as2/describe-server.ts

`stedi as2 import-certificate`

Creates a Stedi AS2 certificate.

USAGE
  $ stedi as2 import-certificate -n <value> --usage SIGNING|ENCRYPTION --certificate <value> [-a <value>] [-v]
    [--description <value>] [--certificate-chain <value>] [--private-key <value>] [--active-date <value>]
    [--inactive-date <value>]

FLAGS
  -a, --api-key=<value>            API Key used for Authentication, defaults to STEDI_API_KEY environment variable or
                                   api-key attribute from .stedirc file.
  -n, --name=<value>               (required) AS2 certificate name
  -v, --verbose                    when set to true will output additional logs to the cli output
      --active-date=<value>        AS2 certificate active date
      --certificate=<value>        (required) AS2 certificate body
      --certificate-chain=<value>  AS2 root certificate body
      --description=<value>        AS2 certificate description. Note that only alphanumeric characters, dashes, and
                                   underscores are allowed.
      --inactive-date=<value>      AS2 certificate inactiveDate date
      --private-key=<value>        AS2 certificate private key
      --usage=<option>             (required) AS2 certificate usage
                                   <options: SIGNING|ENCRYPTION>

DESCRIPTION
  Creates a Stedi AS2 certificate.

See code: src/commands/as2/import-certificate.ts

`stedi as2 list-agreements`

List AS2 Agreements.

USAGE
  $ stedi as2 list-agreements [-a <value>] [-v]

FLAGS
  -a, --api-key=<value>  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

DESCRIPTION
  List AS2 Agreements.

See code: src/commands/as2/list-agreements.ts

`stedi as2 list-certificates`

List AS2 Certificates.

USAGE
  $ stedi as2 list-certificates [-a <value>] [-v]

FLAGS
  -a, --api-key=<value>  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

DESCRIPTION
  List AS2 Certificates.

See code: src/commands/as2/list-certificates.ts

`stedi as2 list-connectors`

List AS2 Connectors.

USAGE
  $ stedi as2 list-connectors [-a <value>] [-v]

FLAGS
  -a, --api-key=<value>  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

DESCRIPTION
  List AS2 Connectors.

See code: src/commands/as2/list-connectors.ts

`stedi as2 list-profiles`

List AS2 Profiles.

USAGE
  $ stedi as2 list-profiles [-a <value>] [-v]

FLAGS
  -a, --api-key=<value>  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

DESCRIPTION
  List AS2 Profiles.

See code: src/commands/as2/list-profiles.ts

`stedi as2 list-servers`

List AS2 Servers.

USAGE
  $ stedi as2 list-servers [-a <value>] [-v]

FLAGS
  -a, --api-key=<value>  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

DESCRIPTION
  List AS2 Servers.

See code: src/commands/as2/list-servers.ts

`stedi as2 start-file-transfer`

Begins an outbound file transfer to an AS2 server. You specify the ConnectorId and the file paths for where to send the files.

USAGE
  $ stedi as2 start-file-transfer --connector-id <value> --send-file-paths <value>... [-a <value>] [-v]

FLAGS
  -a, --api-key=<value>             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
      --connector-id=<value>        (required) The connector id
      --send-file-paths=<value>...  (required) Space separated strings representing paths. Each path represents the
                                    absolute Stedi Buckets path for one outbound file transfer. For example,
                                    ``/as2-outbound-bucket/myfile.txt `` .

DESCRIPTION
  Begins an outbound file transfer to an AS2 server. You specify the ConnectorId and the file paths for where to send
  the files.

See code: src/commands/as2/start-file-transfer.ts

`stedi as2 update-agreement`

Update a Stedi AS2 Agreement.

USAGE
  $ stedi as2 update-agreement -n <value> [-a <value>] [-v] [--server-id <value>] [--local-profile-id <value>]
    [--partner-profile-id <value>] [--base-directory <value>] [--status ACTIVE|INACTIVE] [--description <value>]

FLAGS
  -a, --api-key=<value>             API Key used for Authentication, defaults to STEDI_API_KEY environment variable or
                                    api-key attribute from .stedirc file.
  -n, --name=<value>                (required) AS2 agreement name
  -v, --verbose                     when set to true will output additional logs to the cli output
      --base-directory=<value>      Stedi bucket base directory
      --description=<value>         AS2 agreement description. Note that only alphanumeric characters, dashes, and
                                    underscores are allowed.
      --local-profile-id=<value>    AS2 local profile id
      --partner-profile-id=<value>  AS2 partner profile id
      --server-id=<value>           AS2 Server Id
      --status=<option>             AS2 agreement status
                                    <options: ACTIVE|INACTIVE>

DESCRIPTION
  Update a Stedi AS2 Agreement.

See code: src/commands/as2/update-agreement.ts

`stedi as2 update-certificate`

Update a Stedi AS2 Certificate.

USAGE
  $ stedi as2 update-certificate -n <value> [-a <value>] [-v] [--description <value>] [--active-date <value>]
    [--inactive-date <value>]

FLAGS
  -a, --api-key=<value>        API Key used for Authentication, defaults to STEDI_API_KEY environment variable or
                               api-key attribute from .stedirc file.
  -n, --name=<value>           (required) AS2 certificate name
  -v, --verbose                when set to true will output additional logs to the cli output
      --active-date=<value>    AS2 certificate active date
      --description=<value>    AS2 certificate description. Note that only alphanumeric characters, dashes, and
                               underscores are allowed.
      --inactive-date=<value>  AS2 certificate inactiveDate date

DESCRIPTION
  Update a Stedi AS2 Certificate.

See code: src/commands/as2/update-certificate.ts

`stedi as2 update-connector`

Update a Stedi AS2 Agreement.

USAGE
  $ stedi as2 update-connector [-a <value>] [-v] [-n <value>] [--url <value>] [--local-profile-id <value>]
    [--partner-profile-id <value>] [--compression ZLIB|DISABLED] [--message-subject <value>] [--encryption-algorithm
    AES128_CBC|AES192_CBC|AES256_CBC] [--signing-algorithm SHA256|SHA384|SHA512|SHA1|NONE] [--mdn-signing-algorithm
    SHA256|SHA384|SHA512|SHA1|NONE|DEFAULT] [--mdn-response SYNC|NONE]

FLAGS
  -a, --api-key=<value>                 API Key used for Authentication, defaults to STEDI_API_KEY environment variable
                                        or api-key attribute from .stedirc file.
  -n, --name=<value>                    AS2 connector name
  -v, --verbose                         when set to true will output additional logs to the cli output
      --compression=<option>            Compression algorithm, can be ZLIB or DISABLED
                                        <options: ZLIB|DISABLED>
      --encryption-algorithm=<option>   The algorithm that is used to encrypt the file. Valid values: AES128_CBC |
                                        AES192_CBC | AES256_CBC.
                                        <options: AES128_CBC|AES192_CBC|AES256_CBC>
      --local-profile-id=<value>        AS2 local profile id
      --mdn-response=<option>           Specify if MDN response is required.
                                        <options: SYNC|NONE>
      --mdn-signing-algorithm=<option>  The signing algorithm for the MDN response. Valid values: SHA256 | SHA384 |
                                        SHA512 | SHA1 | NONE | DEFAULT (DEFAULT = use same algorithm as
                                        signing-algorithm).
                                        <options: SHA256|SHA384|SHA512|SHA1|NONE|DEFAULT>
      --message-subject=<value>         Used as the Subject HTTP header attribute in AS2 messages that are being sent
                                        with the connector.
      --partner-profile-id=<value>      AS2 partner profile id
      --signing-algorithm=<option>      The algorithm that is used to sign the AS2 messages sent with the connector.
                                        Valid values: SHA256 | SHA384 | SHA512 | SHA1 | NONE.
                                        <options: SHA256|SHA384|SHA512|SHA1|NONE>
      --url=<value>                     AS2 Partner URL

DESCRIPTION
  Update a Stedi AS2 Agreement.

See code: src/commands/as2/update-connector.ts

`stedi as2 update-profile`

Update a Stedi AS2 Profile.

USAGE
  $ stedi as2 update-profile -n <value> [-a <value>] [-v] [--certificate-ids <value>]

FLAGS
  -a, --api-key=<value>          API Key used for Authentication, defaults to STEDI_API_KEY environment variable or
                                 api-key attribute from .stedirc file.
  -n, --name=<value>             (required) AS2 profile name
  -v, --verbose                  when set to true will output additional logs to the cli output
      --certificate-ids=<value>  Comma separated string of certificate ids

DESCRIPTION
  Update a Stedi AS2 Profile.

See code: src/commands/as2/update-profile.ts

`stedi buckets create-bucket`

Creates a new Stedi Bucket that can be used to store objects.

USAGE
  $ stedi buckets create-bucket -n <value> [-a <value>] [-v]

FLAGS
  -a, --api-key=<value>      API Key used for Authentication, defaults to STEDI_API_KEY environment variable or api-key
                             attribute from .stedirc file.
  -n, --bucket-name=<value>  (required) Name of the resource to create
  -v, --verbose              when set to true will output additional logs to the cli output

DESCRIPTION
  Creates a new Stedi Bucket that can be used to store objects.

See code: src/commands/buckets/create-bucket.ts

`stedi buckets delete-bucket`

Delete bucket from your Stedi account.

USAGE
  $ stedi buckets delete-bucket -n <value> [-a <value>] [-v]

FLAGS
  -a, --api-key=<value>      API Key used for Authentication, defaults to STEDI_API_KEY environment variable or api-key
                             attribute from .stedirc file.
  -n, --bucket-name=<value>  (required) Name of the resource to delete
  -v, --verbose              when set to true will output additional logs to the cli output

DESCRIPTION
  Delete bucket from your Stedi account.

See code: src/commands/buckets/delete-bucket.ts

`stedi buckets delete-object`

Delete object from a Stedi Bucket.

USAGE
  $ stedi buckets delete-object -n <value> -k <value> [-a <value>] [-v]

FLAGS
  -a, --api-key=<value>      API Key used for Authentication, defaults to STEDI_API_KEY environment variable or api-key
                             attribute from .stedirc file.
  -k, --key=<value>          (required) Object key
  -n, --bucket-name=<value>  (required) Bucket name
  -v, --verbose              when set to true will output additional logs to the cli output

DESCRIPTION
  Delete object from a Stedi Bucket.

See code: src/commands/buckets/delete-object.ts

`stedi buckets describe-bucket`

Describe bucket from your Stedi account.

USAGE
  $ stedi buckets describe-bucket -n <value> [-a <value>] [-v]

FLAGS
  -a, --api-key=<value>      API Key used for Authentication, defaults to STEDI_API_KEY environment variable or api-key
                             attribute from .stedirc file.
  -n, --bucket-name=<value>  (required) Name of the resource to read
  -v, --verbose              when set to true will output additional logs to the cli output

DESCRIPTION
  Describe bucket from your Stedi account.

See code: src/commands/buckets/describe-bucket.ts

`stedi buckets list-buckets`

List Buckets for your Stedi account.

USAGE
  $ stedi buckets list-buckets [-a <value>] [-v]

FLAGS
  -a, --api-key=<value>  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

DESCRIPTION
  List Buckets for your Stedi account.

See code: src/commands/buckets/list-buckets.ts

`stedi buckets put-object`

Uploads an object to a Stedi Bucket.

USAGE
  $ stedi buckets put-object -n <value> -k <value> [-a <value>] [-v] [-b <value>]

FLAGS
  -a, --api-key=<value>      API Key used for Authentication, defaults to STEDI_API_KEY environment variable or api-key
                             attribute from .stedirc file.
  -b, --body=<value>         Input body for the object. It can be a JSON or a file path.
  -k, --key=<value>          (required) Object key
  -n, --bucket-name=<value>  (required) Bucket name
  -v, --verbose              when set to true will output additional logs to the cli output

DESCRIPTION
  Uploads an object to a Stedi Bucket.

See code: src/commands/buckets/put-object.ts

`stedi buckets update-bucket`

Modifies the configuration of an existing Stedi Bucket.

USAGE
  $ stedi buckets update-bucket -n <value> [-a <value>] [-v]

FLAGS
  -a, --api-key=<value>      API Key used for Authentication, defaults to STEDI_API_KEY environment variable or api-key
                             attribute from .stedirc file.
  -n, --bucket-name=<value>  (required) Name of the resource to update
  -v, --verbose              when set to true will output additional logs to the cli output

DESCRIPTION
  Modifies the configuration of an existing Stedi Bucket.

See code: src/commands/buckets/update-bucket.ts

`stedi event-bindings create-event-binding`

Create event bindings for your Stedi functions.

USAGE
  $ stedi event-bindings create-event-binding -n <value> -f <value> -p <value> [-a <value>] [-v]

FLAGS
  -a, --api-key=<value>                         API Key used for Authentication, defaults to STEDI_API_KEY environment
                                                variable or api-key attribute from .stedirc file.
  -f, --function-name=<value>                   (required) Name of the function to which the event binding is attached
  -n, --event-to-function-binding-name=<value>  (required) Name of the event binding
  -p, --event-pattern=<value>                   (required) Event pattern in stringified JSON format. See https://docs.aw
                                                s.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html
  -v, --verbose                                 when set to true will output additional logs to the cli output

DESCRIPTION
  Create event bindings for your Stedi functions.

See code: src/commands/event-bindings/create-event-binding.ts

`stedi event-bindings delete-event-binding`

Create event bindings for your Stedi functions.

USAGE
  $ stedi event-bindings delete-event-binding -n <value> [-a <value>] [-v]

FLAGS
  -a, --api-key=<value>                         API Key used for Authentication, defaults to STEDI_API_KEY environment
                                                variable or api-key attribute from .stedirc file.
  -n, --event-to-function-binding-name=<value>  (required) Name of the event binding
  -v, --verbose                                 when set to true will output additional logs to the cli output

DESCRIPTION
  Create event bindings for your Stedi functions.

See code: src/commands/event-bindings/delete-event-binding.ts

`stedi event-bindings describe-event-binding`

Describe an event binding in your Stedi account.

USAGE
  $ stedi event-bindings describe-event-binding -n <value> [-a <value>] [-v]

FLAGS
  -a, --api-key=<value>                         API Key used for Authentication, defaults to STEDI_API_KEY environment
                                                variable or api-key attribute from .stedirc file.
  -n, --event-to-function-binding-name=<value>  (required) Name of the event binding
  -v, --verbose                                 when set to true will output additional logs to the cli output

DESCRIPTION
  Describe an event binding in your Stedi account.

See code: src/commands/event-bindings/describe-event-binding.ts

`stedi event-bindings update-event-binding`

Update an existing event binding.

USAGE
  $ stedi event-bindings update-event-binding -n <value> -f <value> [-a <value>] [-v] [-p <value>]

FLAGS
  -a, --api-key=<value>                         API Key used for Authentication, defaults to STEDI_API_KEY environment
                                                variable or api-key attribute from .stedirc file.
  -f, --function-name=<value>                   (required) Name of the function to which the event binding is attached
  -n, --event-to-function-binding-name=<value>  (required) Name of the event binding
  -p, --event-pattern=<value>                   Event pattern in stringified JSON format. See https://docs.aws.amazon.co
                                                m/eventbridge/latest/userguide/eb-event-patterns.html
  -v, --verbose                                 when set to true will output additional logs to the cli output

DESCRIPTION
  Update an existing event binding.

See code: src/commands/event-bindings/update-event-binding.ts

`stedi functions create-function`

Create function for your Stedi account.

USAGE
  $ stedi functions create-function -n <value> -p <value> [-a <value>] [-v] [--environment-variables <value>] [-t
  <value>]

FLAGS
  -a, --api-key=<value>                API Key used for Authentication, defaults to STEDI_API_KEY environment variable
                                       or api-key attribute from .stedirc file.
  -n, --function-name=<value>          (required) Name of the resource to create
  -p, --package=<value>                (required) Path to the package as either a local file (in the format
                                       file://path/file.zip) or a s3 url (in the format s3://bucket/key.zip).
  -t, --timeout=<value>                Function timeout
  -v, --verbose                        when set to true will output additional logs to the cli output
      --environment-variables=<value>  Environment variables will be accessible from function code during execution, as
                                       a JSON encoded object {"ENV_KEY":"value"}.

DESCRIPTION
  Create function for your Stedi account.

See code: src/commands/functions/create-function.ts

`stedi functions delete-function`

Delete function from your Stedi account.

USAGE
  $ stedi functions delete-function -n <value> [-a <value>] [-v]

FLAGS
  -a, --api-key=<value>        API Key used for Authentication, defaults to STEDI_API_KEY environment variable or
                               api-key attribute from .stedirc file.
  -n, --function-name=<value>  (required) Name of the resource to delete
  -v, --verbose                when set to true will output additional logs to the cli output

DESCRIPTION
  Delete function from your Stedi account.

See code: src/commands/functions/delete-function.ts

`stedi functions describe-function`

Describe function from your Stedi account.

USAGE
  $ stedi functions describe-function -n <value> [-a <value>] [-v]

FLAGS
  -a, --api-key=<value>        API Key used for Authentication, defaults to STEDI_API_KEY environment variable or
                               api-key attribute from .stedirc file.
  -n, --function-name=<value>  (required) Name of the resource to read
  -v, --verbose                when set to true will output additional logs to the cli output

DESCRIPTION
  Describe function from your Stedi account.

See code: src/commands/functions/describe-function.ts

`stedi functions describe-function-package`

Describe function package from your Stedi account.

USAGE
  $ stedi functions describe-function-package -n <value> [-a <value>] [-v]

FLAGS
  -a, --api-key=<value>        API Key used for Authentication, defaults to STEDI_API_KEY environment variable or
                               api-key attribute from .stedirc file.
  -n, --function-name=<value>  (required) Name of the resource to read
  -v, --verbose                when set to true will output additional logs to the cli output

DESCRIPTION
  Describe function package from your Stedi account.

See code: src/commands/functions/describe-function-package.ts

`stedi functions invoke-function`

Invoke a function for your Stedi account.

USAGE
  $ stedi functions invoke-function -n <value> [-a <value>] [-v] [-p <value>]

FLAGS
  -a, --api-key=<value>        API Key used for Authentication, defaults to STEDI_API_KEY environment variable or
                               api-key attribute from .stedirc file.
  -n, --function-name=<value>  (required) Name of the resource to invoke.
  -p, --payload=<value>        Input payload for your function execution. It can be a JSON or a file path.
  -v, --verbose                when set to true will output additional logs to the cli output

DESCRIPTION
  Invoke a function for your Stedi account.

See code: src/commands/functions/invoke-function.ts

`stedi functions list-functions`

List functions for your Stedi account.

USAGE
  $ stedi functions list-functions [-a <value>] [-v]

FLAGS
  -a, --api-key=<value>  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

DESCRIPTION
  List functions for your Stedi account.

See code: src/commands/functions/list-functions.ts

`stedi functions update-function`

Update function in your Stedi account.

USAGE
  $ stedi functions update-function -n <value> [-a <value>] [-v] [-p <value>] [--environment-variables <value>] [-t
  <value>]

FLAGS
  -a, --api-key=<value>                API Key used for Authentication, defaults to STEDI_API_KEY environment variable
                                       or api-key attribute from .stedirc file.
  -n, --function-name=<value>          (required) Name of the resource to update
  -p, --package=<value>                Path to the package as either a local file (in the format file://path/file.zip)
                                       or a s3 url (in the format s3://bucket/key.zip).
  -t, --timeout=<value>                Function timeout
  -v, --verbose                        when set to true will output additional logs to the cli output
      --environment-variables=<value>  Environment variables will be accessible from function code during execution, as
                                       a JSON encoded object {"ENV_KEY":"value"}.

DESCRIPTION
  Update function in your Stedi account.

See code: src/commands/functions/update-function.ts

`stedi help [COMMAND]`

Display help for stedi.

USAGE
  $ stedi help [COMMAND...] [-n]

ARGUMENTS
  COMMAND...  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for stedi.

See code: @oclif/plugin-help

`stedi identity create-access-key`

Creates a new secret access key and corresponding access key ID for the specified Machine User.

USAGE
  $ stedi identity create-access-key -n <value> [-a <value>] [-v]

FLAGS
  -a, --api-key=<value>            API Key used for Authentication, defaults to STEDI_API_KEY environment variable or
                                   api-key attribute from .stedirc file.
  -n, --machine-user-name=<value>  (required) Name of the user to create an access key for
  -v, --verbose                    when set to true will output additional logs to the cli output

DESCRIPTION
  Creates a new secret access key and corresponding access key ID for the specified Machine User.

See code: src/commands/identity/create-access-key.ts

`stedi identity create-machine-user`

Creates a new Machine User for your account.

USAGE
  $ stedi identity create-machine-user -n <value> -p <value> [-a <value>] [-v]

FLAGS
  -a, --api-key=<value>            API Key used for Authentication, defaults to STEDI_API_KEY environment variable or
                                   api-key attribute from .stedirc file.
  -n, --machine-user-name=<value>  (required) Name of the resource to create
  -p, --managed-policies=<value>   (required) Comma delimited string of policies for this user
  -v, --verbose                    when set to true will output additional logs to the cli output

DESCRIPTION
  Creates a new Machine User for your account.

See code: src/commands/identity/create-machine-user.ts

`stedi identity delete-access-key`

Deletes the access key pair associated with the specified Machine User.

USAGE
  $ stedi identity delete-access-key -i <value> -n <value> [-a <value>] [-v]

FLAGS
  -a, --api-key=<value>            API Key used for Authentication, defaults to STEDI_API_KEY environment variable or
                                   api-key attribute from .stedirc file.
  -i, --key-id=<value>             (required) ID of the resource to delete
  -n, --machine-user-name=<value>  (required) Name of the user the key belongs to
  -v, --verbose                    when set to true will output additional logs to the cli output

DESCRIPTION
  Deletes the access key pair associated with the specified Machine User.

See code: src/commands/identity/delete-access-key.ts

`stedi identity delete-machine-user`

Deletes the specified Machine User.

USAGE
  $ stedi identity delete-machine-user -n <value> [-a <value>] [-v]

FLAGS
  -a, --api-key=<value>            API Key used for Authentication, defaults to STEDI_API_KEY environment variable or
                                   api-key attribute from .stedirc file.
  -n, --machine-user-name=<value>  (required) Name of the resource to delete
  -v, --verbose                    when set to true will output additional logs to the cli output

DESCRIPTION
  Deletes the specified Machine User.

See code: src/commands/identity/delete-machine-user.ts

`stedi identity describe-machine-user`

Retrieves information about the specified Machine Users user.

USAGE
  $ stedi identity describe-machine-user -n <value> [-a <value>] [-v]

FLAGS
  -a, --api-key=<value>            API Key used for Authentication, defaults to STEDI_API_KEY environment variable or
                                   api-key attribute from .stedirc file.
  -n, --machine-user-name=<value>  (required) Name of the resource to create
  -v, --verbose                    when set to true will output additional logs to the cli output

DESCRIPTION
  Retrieves information about the specified Machine Users user.

See code: src/commands/identity/describe-machine-user.ts

`stedi identity get-access-key-last-used`

Retrieves information about when the specified access key was last used.

USAGE
  $ stedi identity get-access-key-last-used -i <value> [-a <value>] [-v]

FLAGS
  -a, --api-key=<value>  API Key used for Authentication, defaults to STEDI_API_KEY environment variable or api-key
                         attribute from .stedirc file.
  -i, --key-id=<value>   (required) ID of the resource to read
  -v, --verbose          when set to true will output additional logs to the cli output

DESCRIPTION
  Retrieves information about when the specified access key was last used.

See code: src/commands/identity/get-access-key-last-used.ts

`stedi identity list-access-keys`

Returns information about the access key IDs associated with the specified Machine User.

USAGE
  $ stedi identity list-access-keys -n <value> [-a <value>] [-v]

FLAGS
  -a, --api-key=<value>            API Key used for Authentication, defaults to STEDI_API_KEY environment variable or
                                   api-key attribute from .stedirc file.
  -n, --machine-user-name=<value>  (required) Name of the user to get the key list for
  -v, --verbose                    when set to true will output additional logs to the cli output

DESCRIPTION
  Returns information about the access key IDs associated with the specified Machine User.

See code: src/commands/identity/list-access-keys.ts

`stedi identity list-machine-users`

Lists the Machine users in your account. If there are none, the operation returns an empty list.

USAGE
  $ stedi identity list-machine-users [-a <value>] [-v]

FLAGS
  -a, --api-key=<value>  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

DESCRIPTION
  Lists the Machine users in your account. If there are none, the operation returns an empty list.

See code: src/commands/identity/list-machine-users.ts

`stedi identity list-policies`

Lists all the policies that are available in your in your account.

USAGE
  $ stedi identity list-policies [-a <value>] [-v]

FLAGS
  -a, --api-key=<value>  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

DESCRIPTION
  Lists all the policies that are available in your in your account.

See code: src/commands/identity/list-policies.ts

`stedi identity update-access-key`

Changes the status of the specified access key from Active to Inactive, or vice versa.

USAGE
  $ stedi identity update-access-key -n <value> -i <value> -s <value> [-a <value>] [-v]

FLAGS
  -a, --api-key=<value>            API Key used for Authentication, defaults to STEDI_API_KEY environment variable or
                                   api-key attribute from .stedirc file.
  -i, --key-id=<value>             (required) ID of the resource to update
  -n, --machine-user-name=<value>  (required) Name of the resource to create
  -s, --status=<value>             (required) Status to set the key to. Possible values: Active, Inactive
  -v, --verbose                    when set to true will output additional logs to the cli output

DESCRIPTION
  Changes the status of the specified access key from Active to Inactive, or vice versa.

See code: src/commands/identity/update-access-key.ts

`stedi integrations init`

Creates an empty Stedi Integrations SDK project

USAGE
  $ stedi integrations init -p <value> [-a <value>] [-v]

FLAGS
  -a, --api-key=<value>  API Key used for Authentication, defaults to STEDI_API_KEY environment variable or api-key
                         attribute from .stedirc file.
  -p, --path=<value>     (required) [default: my-stedi-project] Path to an empty directory where the new integrations
                         project will be created
  -v, --verbose          when set to true will output additional logs to the cli output

DESCRIPTION
  Creates an empty Stedi Integrations SDK project

See code: src/commands/integrations/init.ts

`stedi mappings diff-mappings`

Compares mappings from your Stedi account against locally persisted versions.

USAGE
  $ stedi mappings diff-mappings [-a <value>] [-v] [-d <value>] [-n <value>] [-f <value>]

FLAGS
  -a, --api-key=<value>         API Key used for Authentication, defaults to STEDI_API_KEY environment variable or
                                api-key attribute from .stedirc file.
  -d, --directory=<value>       [default: .] Directory containing persisted mappings to compare against those in your
                                Stedi account
  -f, --filter-pattern=<value>  Only mappings with names matching the specified regex pattern will be included (case
                                sensitive; do not include leading/trailing slashes)
  -n, --name=<value>            Name of the mapping to compare; if not specified all mappings will be compared
  -v, --verbose                 when set to true will output additional logs to the cli output

DESCRIPTION
  Compares mappings from your Stedi account against locally persisted versions.

See code: src/commands/mappings/diff-mappings.ts

`stedi mappings download-mappings`

Download mappings from your Stedi account.

USAGE
  $ stedi mappings download-mappings [-a <value>] [-v] [-d <value>] [-n <value>] [-f <value>]

FLAGS
  -a, --api-key=<value>         API Key used for Authentication, defaults to STEDI_API_KEY environment variable or
                                api-key attribute from .stedirc file.
  -d, --directory=<value>       [default: .] Output directory that mapping definitions will be written to
  -f, --filter-pattern=<value>  Only mappings with names matching the specified regex pattern will be included (case
                                sensitive; do not include leading/trailing slashes)
  -n, --name=<value>            Name of the mapping to download; if not specified all mappings will be downloaded
  -v, --verbose                 when set to true will output additional logs to the cli output

DESCRIPTION
  Download mappings from your Stedi account.

See code: src/commands/mappings/download-mappings.ts

`stedi mappings list-mappings`

Lists mappings from your Stedi account.

USAGE
  $ stedi mappings list-mappings [-a <value>] [-v] [-f <value>]

FLAGS
  -a, --api-key=<value>         API Key used for Authentication, defaults to STEDI_API_KEY environment variable or
                                api-key attribute from .stedirc file.
  -f, --filter-pattern=<value>  Only mappings with names matching the specified regex pattern will be included (case
                                sensitive; do not include leading/trailing slashes)
  -v, --verbose                 when set to true will output additional logs to the cli output

DESCRIPTION
  Lists mappings from your Stedi account.

See code: src/commands/mappings/list-mappings.ts

`stedi mappings migrate-target-schema`

Migrates mapping for use with the Create Transaction API.

USAGE
  $ stedi mappings migrate-target-schema [-a <value>] [-v] [-i <value> | -f <value> | -n <value>] [-p <value>] [-s
  <value>]

FLAGS
  -a, --api-key=<value>         API Key used for Authentication, defaults to STEDI_API_KEY environment variable or
                                api-key attribute from .stedirc file.
  -f, --filter-pattern=<value>  Only mappings with names matching the specified regex pattern will be included (case
                                sensitive; do not include leading/trailing slashes)
  -i, --ids=<value>             Comma-separated list of IDs of the mappings to migrate
  -n, --name=<value>            Name of the mapping to migrate
  -p, --prefix=<value>          Prefix to use for name of migrated mappings
  -s, --suffix=<value>          [default:  (MIGRATED)] Suffix to use for name of migrated mappings
  -v, --verbose                 when set to true will output additional logs to the cli output

DESCRIPTION
  Migrates mapping for use with the Create Transaction API.

See code: src/commands/mappings/migrate-target-schema.ts

`stedi mappings update-mappings`

Update mappings in your Stedi account.

USAGE
  $ stedi mappings update-mappings [-a <value>] [-v] [-d <value>] [-n <value>] [-f <value>] [--force]

FLAGS
  -a, --api-key=<value>         API Key used for Authentication, defaults to STEDI_API_KEY environment variable or
                                api-key attribute from .stedirc file.
  -d, --directory=<value>       [default: .] Source directory that mapping definitions will be read from
  -f, --filter-pattern=<value>  Only mappings with names matching the specified regex pattern will be included (case
                                sensitive; do not include leading/trailing slashes)
  -n, --name=<value>            Name of the mapping to update; if not specified all mappings in source directory will be
                                updated
  -v, --verbose                 when set to true will output additional logs to the cli output
      --force                   Force update of mapping in account even if current mapping does not match any previous
                                version in persisted definition file

DESCRIPTION
  Update mappings in your Stedi account.

See code: src/commands/mappings/update-mappings.ts

`stedi sftp create-user`

Creates a new Stedi SFTP user.

USAGE
  $ stedi sftp create-user -d <value> --description <value> [-a <value>] [-v] [--password-options <value>]

FLAGS
  -a, --api-key=<value>           API Key used for Authentication, defaults to STEDI_API_KEY environment variable or
                                  api-key attribute from .stedirc file.
  -d, --home-directory=<value>    (required) Home directory of the SFTP user
  -v, --verbose                   when set to true will output additional logs to the cli output
      --description=<value>       (required) Description of the SFTP user
      --password-options=<value>  Password options for the SFTP user

DESCRIPTION
  Creates a new Stedi SFTP user.

See code: src/commands/sftp/create-user.ts

`stedi sftp delete-user`

Deletes a Stedi SFTP user.

USAGE
  $ stedi sftp delete-user -n <value> [-a <value>] [-v]

FLAGS
  -a, --api-key=<value>   API Key used for Authentication, defaults to STEDI_API_KEY environment variable or api-key
                          attribute from .stedirc file.
  -n, --username=<value>  (required) SFTP user name
  -v, --verbose           when set to true will output additional logs to the cli output

DESCRIPTION
  Deletes a Stedi SFTP user.

See code: src/commands/sftp/delete-user.ts

`stedi sftp list-users`

Lists Stedi SFTP users.

USAGE
  $ stedi sftp list-users [-a <value>] [-v]

FLAGS
  -a, --api-key=<value>  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

DESCRIPTION
  Lists Stedi SFTP users.

See code: src/commands/sftp/list-users.ts

`stedi sftp read-user`

Retrieves information about a Stedi SFTP user.

USAGE
  $ stedi sftp read-user -n <value> [-a <value>] [-v]

FLAGS
  -a, --api-key=<value>   API Key used for Authentication, defaults to STEDI_API_KEY environment variable or api-key
                          attribute from .stedirc file.
  -n, --username=<value>  (required) SFTP user name
  -v, --verbose           when set to true will output additional logs to the cli output

DESCRIPTION
  Retrieves information about a Stedi SFTP user.

See code: src/commands/sftp/read-user.ts

`stedi sftp update-user`

Modifies the configuration of an existing SFTP user.

USAGE
  $ stedi sftp update-user -n <value> --description <value> [-a <value>] [-v]

FLAGS
  -a, --api-key=<value>      API Key used for Authentication, defaults to STEDI_API_KEY environment variable or api-key
                             attribute from .stedirc file.
  -n, --username=<value>     (required) SFTP user name
  -v, --verbose              when set to true will output additional logs to the cli output
      --description=<value>  (required) Description of the SFTP user

DESCRIPTION
  Modifies the configuration of an existing SFTP user.

See code: src/commands/sftp/update-user.ts

`stedi version`

USAGE
  $ stedi version [--json] [--verbose]

FLAGS
  --verbose  Show additional information about the CLI.

GLOBAL FLAGS
  --json  Format output as json.

FLAG DESCRIPTIONS
  --verbose  Show additional information about the CLI.

    Additionally shows the architecture, node version, operating system, and versions of plugins that the CLI is using.

See code: @oclif/plugin-version

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

stedi-cli

Usage

Stability

Commands

stedi as2 create-agreement

stedi as2 create-connector

stedi as2 create-profile

stedi as2 create-server

stedi as2 delete-agreement

stedi as2 delete-certificate

stedi as2 delete-connector

stedi as2 delete-profile

stedi as2 delete-server

stedi as2 describe-agreement

stedi as2 describe-certificate

stedi as2 describe-connector

stedi as2 describe-profile

stedi as2 describe-server

stedi as2 import-certificate

stedi as2 list-agreements

stedi as2 list-certificates

stedi as2 list-connectors

stedi as2 list-profiles

stedi as2 list-servers

stedi as2 start-file-transfer

stedi as2 update-agreement

stedi as2 update-certificate

stedi as2 update-connector

stedi as2 update-profile

stedi buckets create-bucket

stedi buckets delete-bucket

stedi buckets delete-object

stedi buckets describe-bucket

stedi buckets list-buckets

stedi buckets put-object

stedi buckets update-bucket

stedi event-bindings create-event-binding

stedi event-bindings delete-event-binding

stedi event-bindings describe-event-binding

stedi event-bindings update-event-binding

stedi functions create-function

stedi functions delete-function

stedi functions describe-function

stedi functions describe-function-package

stedi functions invoke-function

stedi functions list-functions

stedi functions update-function

stedi help [COMMAND]

stedi identity create-access-key

stedi identity create-machine-user

stedi identity delete-access-key

stedi identity delete-machine-user

stedi identity describe-machine-user

stedi identity get-access-key-last-used

stedi identity list-access-keys

stedi identity list-machine-users

stedi identity list-policies

stedi identity update-access-key

stedi integrations init

stedi mappings diff-mappings

stedi mappings download-mappings

stedi mappings list-mappings

stedi mappings migrate-target-schema

stedi mappings update-mappings

stedi sftp create-user

stedi sftp delete-user

stedi sftp list-users

stedi sftp read-user

stedi sftp update-user

stedi version