super-easy-forms-cli

a CLIfor super-easy-forms

• Usage
• Commands

Usage

$ npm install -g super-easy-forms-cli
$ sef COMMAND
running command...
$ sef (-v|--version|version)
super-easy-forms-cli/1.1.2 linux-x64 node-v12.13.1
$ sef --help [COMMAND]
USAGE
  $ sef COMMAND
...

Commands

• sef build
• sef delete NAME
• sef deploy NAME
• sef email EMAIL [NAME]
• sef form NAME
• sef fullform NAME
• sef help [COMMAND]
• sef iam USER [REGION]
• sef init NAME
• sef lambda NAME [ACTION]
• sef submissions NAME
• sef template NAME
• sef variable NAME VARIABLE VALUE

sef build

Builds the required base files and directories.

USAGE
  $ sef build

OPTIONS
  -p, --profile=profile  The name of the iam profile/user that you want to create
  -r, --region=region    The desired AWS region were your forms infrastructure will be deployed

See code: src/commands/build.js

sef delete NAME

Deletes all resources in the AWS cloud for the desired form

USAGE
  $ sef delete NAME

ARGUMENTS
  NAME  name of the form you want to delete

OPTIONS
  -r, --resources  Delete all of the back-end resources for your form in the cloud

See code: src/commands/delete.js

sef deploy NAME

Deploys your stack in the AWS Cloud

USAGE
  $ sef deploy NAME

ARGUMENTS
  NAME  name of the form you want to delete

OPTIONS
  -c, --create  Deploy a new cloudformation stack in the AWS cloud
  -u, --update  Update your stack in the AWS cloud

See code: src/commands/deploy.js

sef email EMAIL [NAME]

Verifies/validates your email with AWS SES

USAGE
  $ sef email EMAIL [NAME]

ARGUMENTS
  EMAIL  the email address that will send the form submission emails
  NAME   name of the form - must be unique

OPTIONS
  -n, --new       verifies a new email address to be used by AWS SES to send email
  -v, --validate  validates that the provided email address was verified with AWS SES

See code: src/commands/email.js

sef form NAME

Builds an html form

USAGE
  $ sef form NAME

ARGUMENTS
  NAME  name of the form - must be unique

OPTIONS
  -c, --captcha        Adds recaptcha elements and scripts to the form
  -f, --fields=fields  Desired form formFields
  -l, --labels         Automatically add labels to your form
  -u, --url=url        The API endpoint endpointUrl for your form

See code: src/commands/form.js

sef fullform NAME

Generates an html form and saves it in the formNames folder

USAGE
  $ sef fullform NAME

ARGUMENTS
  NAME  name of the form - must be unique

OPTIONS
  -c, --captcha                Adds recaptcha elements and scripts to the form and lambda function
  -e, --email=email            Email address that will be used to send emails
  -f, --fields=fields          Desired form formFields
  -l, --labels                 Automatically add labels to your form

  -m, --message=message        the email message body. you can use html and you can use <FormOutput> to include the
                               information from the form submission

  -r, --recipients=recipients  Recipients that will recieve emails on your behalf.

  -s, --subject=subject        the subject of the email message

See code: src/commands/fullform.js

sef help [COMMAND]

display help for sef

USAGE
  $ sef help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

sef iam USER [REGION]

the --create flag will open up a window with the AWS console so that you confirm the creation of a user with the entered name.

USAGE
  $ sef iam USER [REGION]

ARGUMENTS
  USER    name of the IAM user
  REGION  your desired AWS region.

OPTIONS
  -c, --create  Helps you create an IAM user and adds its profile to the .env file

See code: src/commands/iam.js

sef init NAME

Creates a config file with empty values for your form.

USAGE
  $ sef init NAME

ARGUMENTS
  NAME  name of the form you want to initialize

See code: src/commands/init.js

sef lambda NAME [ACTION]

Creates or updates a lambda function and optionally zips and uploads it into an AWS s3 bucket.

USAGE
  $ sef lambda NAME [ACTION]

ARGUMENTS
  NAME    name of the form - must be unique
  ACTION  (create|update) [default: create] action to perform to the lambda function - create or update

OPTIONS
  -b, --bucket                 creates a new s3 bucket and uploads the zipped lambda function
  -c, --captcha                Adds recaptcha elements to the lambda function
  -e, --email=email            Email address that will be used to send emails
  -f, --fields=fields          Desired form formFields

  -m, --message=message        the email message body. you can use html and you can use <FormOutput> to include the
                               information from the form submission

  -r, --recipients=recipients  Recipients that will recieve emails on your behalf.

  -s, --subject=subject        the subject of the email message

  -z, --zip                    zips the lambda function

See code: src/commands/lambda.js

sef submissions NAME

export or list all of the suibmissions you have had to date for a selected form

USAGE
  $ sef submissions NAME

ARGUMENTS
  NAME  name of the form

OPTIONS
  -e, --export           Exports all submissions for the form to its folder
  -f, --format=csv|json  Desired format csv|json
  -l, --list             print all submissions for the form to stdout

See code: src/commands/submissions.js

sef template NAME

validate/create/update your cloudformation template saved locally

USAGE
  $ sef template NAME

ARGUMENTS
  NAME  name of the form - must be unique

OPTIONS
  -c, --create         Create a new cloudformation temmplate and saves it locally
  -e, --email=email    Email address that will be used to send emails
  -f, --fields=fields  Desired form formFields
  -v, --validate       Validate your cloudformation template with AWS

See code: src/commands/template.js

sef variable NAME VARIABLE VALUE

Builds an html form

USAGE
  $ sef variable NAME VARIABLE VALUE

ARGUMENTS
  NAME      name of the form
  VARIABLE  name of the variable
  VALUE     value of the variable

See code: src/commands/variable.js

• sef build
• sef email
• sef form NAME
• sef fullform NAME
• sef help [COMMAND]
• sef lambda NAME
• sef submissions
• sef template

sef build

Builds the required base files and directories.

USAGE
  $ sef build

See code: src/commands/build.js

sef email

Describe the command here

USAGE
  $ sef email

OPTIONS
  -n, --name=name  name to print

DESCRIPTION
  ...
  Extra documentation goes here

See code: src/commands/email.js

sef form NAME

Builds an html form

USAGE
  $ sef form NAME

ARGUMENTS
  NAME  name of the form - must be unique

OPTIONS
  -f, --fields=fields  Desired form formFields
  -l, --labels         Automatically add labels to your form
  -u, --url=url        The API endpoint endpointUrl for your form

See code: src/commands/form.js

sef fullform NAME

Builds an html form

USAGE
  $ sef fullform NAME

ARGUMENTS
  NAME  name of the form - must be unique

OPTIONS
  -e, --email=email            Desired form formFields
  -f, --fields=fields          Desired form formFields
  -l, --labels                 Automatically add labels to your form
  -r, --recipients=recipients  recipients that will recieve emails on your behalf.

See code: src/commands/fullform.js

sef help [COMMAND]

display help for sef

USAGE
  $ sef help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

sef lambda NAME

Builds an html form

USAGE
  $ sef lambda NAME

ARGUMENTS
  NAME  name of the form - must be unique

OPTIONS
  -e, --email=email            Email address that will be used to send emails
  -f, --fields=fields          Desired form formFields
  -r, --recipients=recipients  Recipients that will recieve emails on your behalf.

See code: src/commands/lambda.js

sef submissions

Describe the command here

USAGE
  $ sef submissions

OPTIONS
  -n, --name=name  name to print

DESCRIPTION
  ...
  Extra documentation goes here

See code: src/commands/submissions.js

sef template

Describe the command here

USAGE
  $ sef template

OPTIONS
  -n, --name=name  name to print

DESCRIPTION
  ...
  Extra documentation goes here

See code: src/commands/template.js