Mitch Garnaat

Updated readme file based on change in CLI.

Showing 1 changed file with 14 additions and 9 deletions
...@@ -31,15 +31,20 @@ your function on. ...@@ -31,15 +31,20 @@ your function on.
31 31
32 Kappa is a command line tool. The basic command format is: 32 Kappa is a command line tool. The basic command format is:
33 33
34 - kappa --config <path to config file> <command> 34 + kappa <path to config file> <command> [optional command args]
35 35
36 Where ``command`` is one of: 36 Where ``command`` is one of:
37 37
38 -* deploy - deploy the CloudFormation template containing the IAM roles and zip the function and upload it to AWS Lambda 38 +* deploy - deploy the CloudFormation template containing the IAM roles and zip
39 + the function and upload it to AWS Lambda
39 * test - send test data to the new Lambda function 40 * test - send test data to the new Lambda function
40 -* tail - display the most recent log events for the function (remember that it can take several minutes before log events are available from CloudWatch) 41 +* tail - display the most recent log events for the function (remember that it
42 + can take several minutes before log events are available from CloudWatch)
41 * add-event-sources - hook up an event source to your Lambda function 43 * add-event-sources - hook up an event source to your Lambda function
42 -* delete - delete the CloudFormation stack containing the IAM roles and delete the Lambda function 44 +* delete - delete the CloudFormation stack containing the IAM roles and delete
45 + the Lambda function
46 +* status - display summary information about functions, stacks, and event
47 + sources related to your project.
43 48
44 The ``config file`` is a YAML format file containing all of the information 49 The ``config file`` is a YAML format file containing all of the information
45 about your Lambda function. 50 about your Lambda function.
...@@ -56,11 +61,11 @@ The basic workflow is: ...@@ -56,11 +61,11 @@ The basic workflow is:
56 * Create your CloudFormation template with the execution and invocation roles 61 * Create your CloudFormation template with the execution and invocation roles
57 * Create some sample data 62 * Create some sample data
58 * Create the YAML config file with all of the information 63 * Create the YAML config file with all of the information
59 -* Run ``kappa --config <path-to-config> deploy`` to create roles and upload function 64 +* Run ``kappa <path-to-config> deploy`` to create roles and upload function
60 -* Run ``kappa --config <path-to-config> test`` to invoke the function with test data 65 +* Run ``kappa <path-to-config> test`` to invoke the function with test data
61 -* Run ``kappa --config <path-to-config> tail`` to view the functions output in CloudWatch logs 66 +* Run ``kappa <path-to-config> tail`` to view the functions output in CloudWatch logs
62 -* Run ``kappa --config <path-to-config> add-event-source`` to hook your function up to the event source 67 +* Run ``kappa <path-to-config> add-event-source`` to hook your function up to the event source
63 -* Run ``kappa --config <path-to-config> tail`` to see more output 68 +* Run ``kappa <path-to-config> tail`` to see more output
64 69
65 If you have to make changes in your function or in your IAM roles, simply run 70 If you have to make changes in your function or in your IAM roles, simply run
66 ``kappa deploy`` again and the changes will be uploaded as necessary. 71 ``kappa deploy`` again and the changes will be uploaded as necessary.
......