JAWS CLI Commands

jaws new

Creates a new project, new stage in existing project, or a new region in an existing stage. The new command by default creates resources in AWS (via CloudFormation)

type `project`

This makes a new JAWS project by creating the file structure in the project layout section to the current working directory.

Walks the user through the following prompts asking for their AWS credentials/profile and their project specifications
Creates a CloudFormation Stack for the user’s first stage, which creates an IAM Group and a staged IAM Role for that IAM Group
Creates all project scaffolding in current working directory
Creates an AWS API Gateway REST API for the project
Creates environment var file in the s3 bucket (created if DNE) for the initial stage. Why s3?

type `region`

Creates new region in existing project. By default executes CloudFormation to make one stage in new region.

type `stage`

Creates a new stage in existing region. By default executes CloudFormation to make new stage.

type `action`

Creates one or both of the following in the back/aws_modules folder:

A lambda function in the back/aws_modules folder with basic scaffolding.
An API gateway configuration

jaws dash

Interactive dashboard used to get an overview of your project and deploy resources

jaws env

Manages environment variable files for all stages. There is a reserved stage local which stores the env var file in back/.env. Otherwise they are stored is s3 at s3://<proj jaws.json:envVarBucket.name>/JAWS/envVars/<projectName>/<stage>

Supported operations:

list: List all env vars for given stage. Will display env vars that each jaws-module uses AND indicates env vars that are not yet set.
get: get the value for a specific key
set: set value for key
unset: remove a specific key

When code is deployed via jaws deploy or jaws dash the env var file is downloaded from s3 and put in the root of the zip file named .env. This exactly replicates the code layout of local development, as the root of the zip starts at the back dir.

jaws tag

Non-interactive way (dash alternative) to indicate which (or all) labmda|api changes to deploy when the jaws deploy command is run.

jaws deploy

Non-interactive way (dash alternative) to deploy lambda|api resources that have been jaws tag. If jaws deploy is run from a lambda dir (has lambda attr defined in its jaws.json) it will automatically tag and then deploy.

When deploying a Lambda function to AWS, JAWS will:

Check the Runtime specified in the current lambda’s jaws.json (dir running JAWS cli from) and perform a corresponding build pipeline. Optionally optimize the code for performance in Lambda (browserify & uglifyjs2). See the lambda attributes for optimization options. Why optimize?
Create or update lambda using this naming convention: STAGE_-_PROJECTNAME_-_FUNCTIONNAME. For example: prod_-_MyApp_-_usersSignup
Upload the file as a buffer directly to AWS.

jaws install

The jaws install command downloads the JAWS-module from the location specified (a github repo) and installs it. The install includes:

If the --save flag was used and if cfExtensions CloudFormation template was included in the module’s jaws.json, it merges the contents into the project’s jaws-cf.json. You will have to manually divide this up into multiple CF templates afterwards, if that’s your preference.
Copies the jaws-module into the back/aws_modules dir of the project you are currently in

jaws log

This command fetches logs from AWS Cloudformation for the lambda function in a given region & stage.

This command is not implemented yet. Looking for help from community. Need a way to stream the logs "real time" like heroku logs.

4.1 KiB Raw Blame History Unescape Escape