Skip to content

Commit d0777a1

Browse files
committed
Readme file modified
1 parent 53d91c5 commit d0777a1

File tree

1 file changed

+19
-17
lines changed

1 file changed

+19
-17
lines changed

README.md

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,22 @@
11
# Docker image for ASK and AWS CLI
22

3-
The purpose of this container is to be able to use the [Amazon ASK CLI (Alexa Skills Kit)](https://developer.amazon.com/docs/smapi/ask-cli-intro.html#alexa-skills-kit-command-line-interface-ask-cli) in a Docker container in Devops pipelines.
3+
The purpose of this container is to be able to use the [Amazon ASK CLI](https://developer.amazon.com/docs/smapi/ask-cli-intro.html#alexa-skills-kit-command-line-interface-ask-cli) and [Amazon AWS CLI](https://docs.aws.amazon.com/cli/index.html) in a Docker container in DevOps pipelines.
44

55
**NOTE:** This is a fork from [martindsouza](https://github.com/martindsouza/docker-amazon-ask-cli) image with these changes:
66
1. Image base is the latest LTS version instead of the current version of Node.js.
77
2. Added ASK_CLI_VERSION build argument in order to be able to work with different ASK CLI versions.
88
3. Added git and zip packages that ASK CLI will use in its commands.
99
4. Added Bespoken.
10-
5. Remove volumes. I think it is not necessary in a simple docker image that I will use in my devops pipelines. In addition, you can use '-v' argument in `docker run` command whenever you want.
10+
5. Remove volumes. I think it is not necessary in a simple docker image that I will use in my DevOps pipelines. In addition, you can use '-v' argument in `docker run` command whenever you want.
1111

1212
## ASK Config
1313

14-
Before running this example ensure that you've registered for an [Alexa Developer](https://developer.amazon.com/alexa) account.
14+
You have to take into account that you have to have an [Alexa Developer](https://developer.amazon.com/alexa) account to be able to work with this container.
1515

1616
### ask configure
1717

18-
Running `ask configure` in v2 and `ask init` in v1 in the container will ask you a set of questions to create the Alexa credentials. Follow all the steps explained in the official documentation[https://developer.amazon.com/en-US/docs/alexa/smapi/manage-credentials-with-ask-cli.html].
18+
Running `ask configure` in v2 and `ask init` in v1 in the container will ask you a set of questions to create the Alexa credentials.
19+
Follow all the steps explained in the official documentation[https://developer.amazon.com/en-US/docs/alexa/smapi/manage-credentials-with-ask-cli.html].
1920

2021
In either case ensure that you pass in `-v $(pwd)/ask-config:/home/node/.ask \` (where `$(pwd)/ask-config` is a location on your host machine) as an option when running the container to preserve the ASK configuration.
2122

@@ -39,13 +40,14 @@ If you are using Alexa environment variable you have to add a new profile called
3940

4041
## AWS Config
4142

42-
If you plan to use [Lambda](https://aws.amazon.com/lambda/) you'll need to configure the AWS CLI. To simplify. You can configure it multiple ways.
43+
If you plan to use [AWS Lambda](https://aws.amazon.com/lambda/) you'll need to configure the AWS CLI. To simplify. You can configure it multiple ways.
4344

4445
In either case ensure that you pass in `-v $(pwd)/aws-config:/home/node/.aws \` (where `$(pwd)/aws-config` is a location on your host machine) as an option when running the container to preserve the AWS configuration.
4546

4647
### aws configure
4748

48-
Running `aws configure` in the container will ask you a set of questions to create the AWS credentials
49+
For general use, the `aws configure` command is the fastest way to set up your AWS CLI installation.
50+
When you enter this command, the AWS CLI prompts you for four pieces of information (access key, secret access key, AWS Region, and output format)
4951

5052
### Setting credentials using environment variables
5153

@@ -59,45 +61,45 @@ For more information about the [AWS environment variables](https://docs.aws.amaz
5961

6062
## Usage
6163

62-
Get the latest version of the container: `docker pull xavidop/alexa-ask-aws-cli`
64+
Get the latest version of the container:
6365

6466
```bash
6567
# Get image
6668
docker pull xavidop/alexa-ask-aws-cli
6769
```
6870

69-
They're two ways to use the `ask` cli for this container which are covered below.
71+
They're two ways to use the `ask` cli for this container described below.
7072

71-
### Run One Command
73+
### Run ASK CLI Commands
7274

73-
In this mode the container will start, you run your `ask` command, then the container is stopped and deleted. _Don't worry your Docker image is still kept._
75+
This is an example that shows up how to execute an `ask` command. After this command is executed, the container will stop.
7476

7577
```bash
7678
docker run -it --rm \
7779
-v $(pwd)/ask-config:/home/node/.ask \
80+
-v $(pwd)/ask-config:/home/node/.aws \
81+
-v $(pwd)/ask-config:/home/node/.bst \
7882
-v $(pwd)/hello-world:/home/node/app \
7983
xavidop/alexa-ask-aws-cli:latest \
8084
ask init -l
8185
```
8286

83-
### Run `bash`, then run `ask`
87+
### Run ASK CLI Commands interactively
8488

85-
In this mode, the container will start, you can then run the container's bash, and the container will stop and delete only once you `exit`.
89+
In this example, the container will start directly with the bash console and then you can execute there all the ASK CLI commands you want.
8690

8791
```bash
8892
docker run -it --rm \
8993
-v $(pwd)/ask-config:/home/node/.ask \
94+
-v $(pwd)/ask-config:/home/node/.aws \
95+
-v $(pwd)/ask-config:/home/node/.bst \
9096
-v $(pwd)/app/HelloWorld:/home/node/app \
9197
xavidop/alexa-ask-aws-cli:latest \
9298
bash
9399

94-
# You'll be prompted with:
95-
# bash-4.3$
96-
#
97-
# Type: exit to end and terminate the container
98100
```
99101

100-
## Developers
102+
## Build and push the image
101103

102104
For ASK CLI v1:
103105
```bash

0 commit comments

Comments
 (0)