Skip to content

Commit 3f57d25

Browse files
authored
Merge pull request actions#46 from akamai/feature/WEEDOCS-2816-update-Sandbox-CLI-messaging
Feature/weedocs 2816 update sandbox cli messaging
2 parents 774e40c + 2ad5832 commit 3f57d25

File tree

7 files changed

+106
-105
lines changed

7 files changed

+106
-105
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,10 @@ When creating the sandbox based on a property, the CLI automatically scans the P
3838
my_laptop:~ username$ akamai sandbox create --property www.example.com:5 --name sandbox_for_example.com --requesthostnames localhost,www.example.com
3939
building origin list
4040
Detected the following origins: origin-www.example.com
41-
? Would you like the Sandbox Client to proxy these to the destination defined in the Akamai config? **Yes**
41+
? Do you want the Sandbox Client to proxy the origins in your dev environment to the destination defined in the Akamai config? Enter **y** and the CLI will automatically update your configuration file. If you want to route sandbox traffic to different development origins, enter **n** to customize the origin mappings.
4242
registering sandbox in local datastore
4343
sandbox_id: 4b3a0c0e-dfe9-4df8-b175-1ed23e293c52 sandbox_for_example.com is now active
44-
Successfully created sandbox_id 4b3a0c0e-dfe9-4df8-b175-1ed23e293c52. Generated sandbox client configuration at /Users/username/.akamai-cli/cache/sandbox-cli/sandboxes/sandbox_for_example.com/config.json please edit this file
44+
Successfully created sandbox_id 4b3a0c0e-dfe9-4df8-b175-1ed23e293c52. Generated sandbox client configuration at /Users/username/.akamai-cli/cache/sandbox-cli/sandboxes/sandbox_for_example.com/config.json Edit this file to specify the port and host for your dev environment.
4545
my_laptop:~ username$
4646
```
4747

cli.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
{
77
"name": "sandbox",
88
"version": "1.0.0",
9-
"description": "Manage akamai sandbox environments",
9+
"description": "Manage Akamai Sandbox environments.",
1010
"bin": "https://github.com/akamai/cli-sandbox/releases/download/{{.Version}}/akamai-{{.Name}}-{{.Version}}-{{.OS}}-{{.Arch}}{{.BinSuffix}}"
1111
}
1212
]

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "akamai-sandbox-cli",
3-
"version": "1.2.1",
4-
"description": "A tool to help manage Akamai Sandboxes. Uses the sandbox {OPEN} API.",
3+
"version": "1.1.10",
4+
"description": "A tool that makes it easier to manage Akamai Sandboxes. Call the Sandbox API from the command line.",
55
"repository": "https://github.com/akamai/cli-sandbox",
66
"scripts": {
77
"build": "npm run build-ts",

schemas/client-config.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
{
22
"id": "/clientConfig",
33
"type": "object",
4-
"description": "object that specifies the information about how the sandbox client should be configured",
4+
"description": "Object that describes how the Sandbox Client should be configured.",
55
"properties": {
66
"sandboxServerInfo": {
7-
"description": "Information about how traffic should be served by the sandbox connector",
7+
"description": "Information about how traffic should be served by the Sandbox Client.",
88
"type": "object",
99
"properties": {
1010
"secure": {

schemas/recipe.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"properties": {
66
"sandbox": {
77
"type": "object",
8-
"description": "object that specifies the information about how the sandbox should be configured",
8+
"description": "Object that describes how the sandbox should be configured.",
99
"properties": {
1010
"name": {
1111
"description": "The name of the sandbox defined by the developer when the sandbox was created. If you do not specify a name, the name will default to the `sandboxId`.",
@@ -32,7 +32,7 @@
3232
"items": {
3333
"properties": {
3434
"requestHostnames": {
35-
"description": "A set of hostnames for use in testing within a developer's sandbox.",
35+
"description": "A set of hostnames that can be used for testing within a developer's sandbox.",
3636
"type": "array",
3737
"items": {
3838
"type": "string"

0 commit comments

Comments
 (0)