Skip to content

Commit 21ef24e

Browse files
committed
Update readme
1 parent 3a5a1d9 commit 21ef24e

File tree

1 file changed

+21
-18
lines changed

1 file changed

+21
-18
lines changed

readme.md

+21-18
Original file line numberDiff line numberDiff line change
@@ -37,31 +37,36 @@ npx arc sandbox
3737
- Defaults to `0.0.0.0` (all available interfaces on your machine)
3838
- To accept local connections only, specify `localhost`
3939
- `-v`, `--verbose` - Enable verbose logging
40-
- `-d`, `--debug` - Enable debose logging
40+
- `-d`, `--debug` - Enable debug logging
4141
- `-q`, `--quiet` - Disable (most) logging
42-
- `--disable-symlinks` - Disable symlinking `src/shared` into all functions and
43-
use file copying instead
42+
- `--disable-symlinks` - Disable symlinking `src/shared` into all functions and use file copying instead
4443

4544

4645
### Environment variables
4746

4847
- `ARC_API_TYPE` - Set the API Gateway API type
4948
- Can be one of `http` (aliased to `httpv2`), `httpv1`, `rest`
5049
- Defaults to `http`
51-
- `ARC_QUIET` - If present, disable (most) logging
52-
- `PORT` - Manually specify HTTP port
53-
- Defaults to `3333`
54-
- `HOST` - Specify the host interface for Sandbox to listen on
50+
- `ARC_ENV` - `testing|staging|production`
51+
- Defaults to `testing`
52+
- `ARC_HOST` - Specify the host interface for Sandbox to listen on
5553
- Defaults to `0.0.0.0` (all available interfaces on your machine)
5654
- To accept local connections only, specify `localhost`
57-
- `ARC_EVENTS_PORT`- Manually specify event bus port
58-
- Defaults to `3334`
59-
- `ARC_TABLES_PORT`- Manually specify local DynamoDB port
60-
- Defaults to `5000`
61-
- `ARC_LOCAL`- If present and used in conjunction with `NODE_ENV=staging|production`, emulates live `staging` or `production` environment
62-
- Uses your local preference file's `@staging` or `@production` environment variables
63-
- Connects Sandbox to live AWS events and DynamoDB infra
64-
- Requires valid AWS credentials with the same profile name as defined in your project manifest
55+
- `ARC_LOCAL`- If present and used in conjunction with `ARC_ENV=staging|production`, emulates live `staging` or `production` environment
56+
- Uses your [local preferences `@env`](../configuration/local-preferences#%40env) environment variables for the appropriate stage
57+
- Connects Sandbox to live AWS events and DynamoDB infrastructure
58+
- Requires valid AWS credentials with the same profile name as defined in your [project manifest](../project-manifest/aws#profile)
59+
- Specify ports:
60+
- `ARC_PORT` - Manually specify HTTP port
61+
- Defaults to `3333`
62+
- `ARC_EVENTS_PORT`- Manually specify event bus port
63+
- Defaults to `4444`
64+
- `ARC_TABLES_PORT`- Manually specify local DynamoDB port
65+
- Defaults to `5555`
66+
- `ARC_INTERNAL_PORT`- Manually specify internal Sandbox + AWS services port
67+
- Defaults to `2222`
68+
- `ARC_DB_EXTERNAL` - (Boolean) Use an external DynamoDB tool (such as [AWS NoSQL Workbench](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/workbench.html))
69+
- `ARC_QUIET` - If present, disable (most) logging
6570

6671
---
6772

@@ -162,9 +167,7 @@ test('Tests go here', () => {
162167

163168
### Requirements
164169

165-
The tests in this repository require that you have the `deno` runtime installed
166-
on your local machine. Install `deno` by visiting
167-
https://deno.land/#installation.
170+
The tests in this repository require that you have the `deno` runtime installed on your local machine. Install `deno` by visiting: https://deno.land/#installation
168171

169172
### Running Tests
170173

0 commit comments

Comments
 (0)