Skip to content

Commit

Permalink
Updates README with CLI help.
Browse files Browse the repository at this point in the history
  • Loading branch information
ryguyk committed Jan 5, 2024
1 parent 8090109 commit 4f13505
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,31 @@ Ensure the value passed into APP_ENV matches the file name of the .env file you

If no value is passed `.env.local` will be used as the default

### Additional flags

Additional env flags can be set by prepending them with "--". To pass arguments through to the underlying utility (e.g. jest) use "--" as a separator.

Examples:

```
yarn dev --NEXT_PUBLIC_DRUPAL_BASE_URL https://staging.cms.va.gov -- --port 3003
```

```
yarn test -- path/to/file
```

Available env variables and underlying utility help can be viewed by appending `-h` to the yarn script:
Examples:

```
yarn test -h
```

```
yarn build -h
```

## Local CMS endpoint

To use the local CMS as an endpoint, follow the install directions for [the CMS repo here](https://github.com/department-of-veterans-affairs/va.gov-cms/blob/main/READMES/getting-started.md).
Expand Down

0 comments on commit 4f13505

Please sign in to comment.