@stedi/cli
Advanced tools
Stedi CLI
$ npm install -g @stedi/cli
$ stedi COMMAND
running command...
$ stedi (--version|-v)
@stedi/cli/1.38.0-beta.2 linux-x64 node-v16.17.1
$ stedi --help [COMMAND]
USAGE
$ stedi COMMAND
...
stedi as2 create-agreementstedi as2 create-certificatestedi as2 create-connectorstedi as2 create-profilestedi as2 create-serverstedi as2 delete-agreementstedi as2 delete-certificatestedi as2 delete-connectorstedi as2 delete-profilestedi as2 delete-serverstedi as2 describe-agreementstedi as2 describe-certificatestedi as2 describe-connectorstedi as2 describe-profilestedi as2 describe-serverstedi as2 list-agreementsstedi as2 list-certificatesstedi as2 list-connectorsstedi as2 list-profilesstedi as2 list-serversstedi as2 start-file-transferstedi as2 update-agreementstedi as2 update-certificatestedi as2 update-connectorstedi as2 update-profilestedi buckets create-bucketstedi buckets delete-bucketstedi buckets delete-objectstedi buckets list-bucketsstedi buckets put-objectstedi buckets read-bucketstedi buckets update-bucketstedi help [COMMAND]stedi sftp create-userstedi sftp delete-userstedi sftp list-usersstedi sftp read-userstedi sftp update-userstedi versionstedi as2 create-agreementCreates 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 --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, --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> (required) AS2 agreement description
--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=(ACTIVE|INACTIVE) (required) AS2 agreement status
DESCRIPTION
Creates a Stedi AS2 agreement.
stedi as2 create-certificateCreates a Stedi AS2 certificate.
USAGE
$ stedi as2 create-certificate -n <value> --usage SIGNING|ENCRYPTION --description <value> --certificate <value> [-a
<value>] [-v] [--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> (required) AS2 certificate description
--inactive-date=<value> AS2 certificate inactiveDate date
--private-key=<value> AS2 certificate private key
--usage=(SIGNING|ENCRYPTION) (required) AS2 certificate usage
DESCRIPTION
Creates a Stedi AS2 certificate.
stedi as2 create-connectorCreates 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 <value>]
[--signing-algorithm <value>] [--mdn-signing-algorithm <value>] [--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=(ZLIB|DISABLED) Compression algorithm, can be ZLIB or DISABLED
--encryption-algorithm=<value> The algorithm that is used to encrypt the file.
--local-profile-id=<value> (required) AS2 local profile id
--mdn-response=<option> Specify if MDN response is required.
<options: SYNC|NONE>
--mdn-signing-algorithm=<value> The signing algorithm for the MDN response.
--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=<value> The algorithm that is used to sign the AS2 messages sent with the connector.
--url=<value> (required) AS2 Partner URL
DESCRIPTION
Creates a Stedi AS2 connector.
stedi as2 create-profileCreates 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=(LOCAL|PARTNER) (required) AS2 profile type
DESCRIPTION
Creates a Stedi AS2 profile.
stedi as2 create-serverCreates 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.
stedi as2 delete-agreementDelete 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.
stedi as2 delete-certificateDelete 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.
stedi as2 delete-connectorDelete 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.
stedi as2 delete-profileCreates 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.
stedi as2 delete-serverDelete 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.
stedi as2 describe-agreementDescribe 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.
stedi as2 describe-certificateDescribe 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.
stedi as2 describe-connectorDescribe 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.
stedi as2 describe-profileDescribe 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.
stedi as2 describe-serverDescribe 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.
stedi as2 list-agreementsList 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.
stedi as2 list-certificatesList 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.
stedi as2 list-connectorsList 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.
stedi as2 list-profilesList 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.
stedi as2 list-serversList 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.
stedi as2 start-file-transferBegins 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) Comma separated string of 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.
stedi as2 update-agreementUpdate 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
--local-profile-id=<value> AS2 local profile id
--partner-profile-id=<value> AS2 partner profile id
--server-id=<value> AS2 Server Id
--status=(ACTIVE|INACTIVE) AS2 agreement status
DESCRIPTION
Update a Stedi AS2 Agreement.
stedi as2 update-certificateUpdate 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
--inactive-date=<value> AS2 certificate inactiveDate date
DESCRIPTION
Update a Stedi AS2 Certificate.
stedi as2 update-connectorUpdate 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
<value>] [--signing-algorithm <value>] [--mdn-signing-algorithm <value>] [--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=(ZLIB|DISABLED) Compression algorithm, can be ZLIB or DISABLED
--encryption-algorithm=<value> The algorithm that is used to encrypt the file.
--local-profile-id=<value> AS2 local profile id
--mdn-response=<option> Specify if MDN response is required.
<options: SYNC|NONE>
--mdn-signing-algorithm=<value> The signing algorithm for the MDN response.
--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=<value> The algorithm that is used to sign the AS2 messages sent with the connector.
--url=<value> AS2 Partner URL
DESCRIPTION
Update a Stedi AS2 Agreement.
stedi as2 update-profileUpdate 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.
stedi buckets create-bucketCreates a new Stedi Bucket that can be used to store objects.
USAGE
$ stedi buckets create-bucket -n <value> [-a <value>] [-v] [--notifications <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, --bucket-name=<value> (required) Name of the resource to create
-v, --verbose when set to true will output additional logs to the cli output
--notifications=<value> Configuration that defines how to handle bucket notifications.
DESCRIPTION
Creates a new Stedi Bucket that can be used to store objects.
stedi buckets delete-bucketDelete 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.
stedi buckets delete-objectDelete 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.
stedi buckets list-bucketsList 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.
stedi buckets put-objectUploads 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.
stedi buckets read-bucketRead bucket from your Stedi account.
USAGE
$ stedi buckets read-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
Read bucket from your Stedi account.
stedi buckets update-bucketModifies the configuration of an existing Stedi Bucket.
USAGE
$ stedi buckets update-bucket -n <value> [-a <value>] [-v] [--notifications <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, --bucket-name=<value> (required) Name of the resource to update
-v, --verbose when set to true will output additional logs to the cli output
--notifications=<value> Configuration that defines how to handle bucket notifications.
DESCRIPTION
Modifies the configuration of an existing Stedi Bucket.
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 sftp create-userCreates 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.
stedi sftp delete-userDeletes 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.
stedi sftp list-usersLists 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.
stedi sftp read-userRetrieves 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.
stedi sftp update-userModifies 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.
stedi versionUSAGE
$ 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
FAQs
stedi cli
The npm package @stedi/cli receives a total of 59 weekly downloads. As such, @stedi/cli popularity was classified as not popular.
We found that @stedi/cli demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Fluent Assertions is facing backlash after dropping the Apache license for a commercial model, leaving users blindsided and questioning contributor rights.
Research
Security News
Socket researchers uncover the risks of a malicious Python package targeting Discord developers.
Security News
The UK is proposing a bold ban on ransomware payments by public entities to disrupt cybercrime, protect critical services, and lead global cybersecurity efforts.