archive-gh-me/serverless
1
0
Fork 0
mirror of https://github.com/serverless/serverless.git synced 2026-01-25 15:07:39 +00:00
Code Issues Projects Releases Wiki Activity

commands: update

Browse Source
This commit is contained in:
Austen 2015-09-20 21:09:43 -07:00
parent a696381a8e
commit c5b58771cf
1 changed files with 35 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

61
docs/commands.md
View File

@ -1,12 +1,12 @@
# JAWS CLI Commands
### jaws new
### JAWS New Commands
Creates a new project, new stage in existing project, or a new region in an existing stage as well as ENV var file in the JAWS S3 bucket for the region. The new command by default creates resources (like IAM roles) in AWS via CloudFormation.
Create a project, a project region or a project stage using the `new` commands.
##### type `project`
#### `jaws new project`
This makes a new JAWS project by creating the file structure in the [project layout](./README.md#project-layout) section to the current working directory.
Makes a new JAWS project by generating scaffolding in the current working directory. The new command by default creates resources (like IAM roles) in AWS via CloudFormation.
1. Walks the user through the following prompts asking for their AWS credentials/profile and their project specifications
1. Creates a CloudFormation Stack for the user’s first stage, which creates an IAM Group and a staged IAM Role for that IAM Group
@ -14,47 +14,56 @@ This makes a new JAWS project by creating the file structure in the [project lay
1. Creates an AWS API Gateway REST API for the project
1. Creates environment var file in the s3 bucket (created if DNE) for the initial stage. [Why s3?](https://github.com/jaws-framework/JAWS/wiki/FAQ#why-do-you-use-an-s3-bucket-to-store-env-vars)
##### type `region`
#### `jaws new region`
Creates new region in existing project. By default executes CloudFormation to make one stage in new region.
##### type `stage`
#### `jaws new stage`
Creates a new stage in existing region. By default executes CloudFormation to make new stage.
### jaws module
### JAWS Module Commands
This command manages [JAWS AWS Modules](https://github.com/awsm-org/awsm).
##### sub-command `install`
Download and installs an awsm from github to the `back/aws_modules` dir. By default installs module dependencies (if any)
##### sub-command `update`
Updates an existing awsm in the `back/aws_modules` dir. By default installs module dependencies (if any)
##### sub-command `create`
#### `jaws module create`
Creates one or both of the following in the `back/aws_modules` folder. Default is to create both:
* A lambda function in the `back/aws_modules` folder with basic scaffolding.
* An API gateway configuration
### jaws dash
#### `jaws module install`
Download and installs an awsm from github to the `back/aws_modules` dir. By default installs module dependencies (if any)
#### `jaws module update`
Updates an existing awsm in the `back/aws_modules` dir. By default installs module dependencies (if any)
### JAWS Dash
#### `jaws dash`
Interactive dashboard used to get an overview of your project and deploy resources
### jaws env
### JAWS ENV Commands
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>`
Modeled after Heroku's environment variable commands, these commands manage 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://<projjaws.json:envVarBucket.name>/JAWS/envVars/<projectName>/<stage>`
Supported operations:
#### `jaws env list`
* `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
List all env vars for given stage. Will display env vars that each jaws-module uses and indicate env vars that are not yet set.
#### `jaws env get`
Get the value for a specific key.
#### `jaws env set`
Set the value for a specific key.
#### `jaws env unset`
Unset the value for 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.