diff --git a/README.md b/README.md index 4e20e3d..04b7a5e 100644 --- a/README.md +++ b/README.md @@ -54,7 +54,7 @@ Add a few lines to your `package.json`. Your [account id](https://console.aws.am ### Environments -Environments for a shep project are defined by the aliases on the functions associated with a project. Environments are created through `shep deploy --env new_env` and managed by using the `shep config` commands. Shep takes a strong stance against having different environments for different functions within a project. If you attempt a command which requires the listing of environments and there is a mismatch detected, then shep will throw a `EnvironmentMistmach` error until you remedy the issue. Most issues can be automatically fixed by using `shep config sync`, the only issues this can't solve are conflicting environment variable values. Conflicting value issues can be solved by using `shep config set my_env CONFLICT_VARIABLE=value`. +Environments for a shep project are defined by the aliases on the functions associated with a project. Environments are created through `shep deploy --env new_env` and managed by using the `shep config` commands. Shep takes a strong stance against having different environments for different functions within a project. If you attempt a command which requires the listing of environments and there is a mismatch detected, then shep will throw a `EnvironmentMistmach` error until you remedy the issue. Most issues can be automatically fixed by using `shep config sync`, the only issues this can't solve are conflicting environment variable values. Conflicting value issues can be solved by using `shep config set --env=my_env CONFLICT_VARIABLE=value`. ### Custom Builds Commands @@ -80,10 +80,10 @@ By default shep builds all your functions using webpack. If your project require This creates a new endpoint as well as a new function for that endpoint. Specifically, it adds a path to `api.json` that is configured to trigger the newly created function. ##### 4. Deploy Run `shep deploy --env development` - This command does a couple things in order to deploy your project: + This command does a couple things in order to deploy your project: * Uses webpack to build your functions. This is equivalent to running `shep build`. * Creates or updates the Lambda functions associated with your project. This includes creating a new version of the function as well as updating the alias such that `development` will point to the version you just created. For more on versioning please consult Amazon's own [documentation](http://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html). - * Creates or updates the API Gateway associated with your project and deploys it to the specified stage, `development` in this case. + * Creates or updates the API Gateway associated with your project and deploys it to the specified stage, `development` in this case. You can test your endpoint by visiting the API URL printed out after the project is deployed. Visiting the `/hello` endpoint which should show `success!`. diff --git a/src/commands/config/remove.js b/src/commands/config/remove.js index 74c9c67..35f947f 100644 --- a/src/commands/config/remove.js +++ b/src/commands/config/remove.js @@ -4,7 +4,7 @@ import * as load from '../../util/load' import reporter from '../../util/reporter' import merge from 'lodash.merge' -export const command = 'remove ' +export const command = 'remove [--env=] ' export const desc = 'Remove environment variables for alias on AWS' export function builder (yargs) { return yargs diff --git a/src/commands/config/set.js b/src/commands/config/set.js index a998c13..cec3be1 100644 --- a/src/commands/config/set.js +++ b/src/commands/config/set.js @@ -4,7 +4,7 @@ import configSet from '../../config-set' import * as load from '../../util/load' import merge from 'lodash.merge' -export const command = 'set ' +export const command = 'set [--env=] ' export const desc = 'Set environment variables for alias on AWS' export function builder (yargs) { return yargs