Skip to content

Commit a02b3ae

Browse files
committed
chore: Add a, "before you begin" section detailing the required .env variable.
Signed-off-by: habeck <habeck@us.ibm.com>
1 parent 639da3a commit a02b3ae

1 file changed

Lines changed: 22 additions & 0 deletions

File tree

cpex/tools/README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,25 @@
1+
## Before you begin
2+
3+
Update the environment variables in .env
4+
5+
All values except PLUGINS_GITHUB_TOKEN have defaults.
6+
7+
```dotenv
8+
### Plugin installation
9+
# Comma Separated Values used by install with --type monorepo
10+
# The default value is https://github.com/ibm/cpex-plugins
11+
# PLUGINS_REPO_URLS="https://github.com/ibm/cpex-plugins"
12+
13+
# registry path (default shown below)
14+
# PLUGIN_REGISTRY_FOLDER=data
15+
16+
# Github API (default shown below)
17+
# PLUGINS_GITHUB_API=api.github.com
18+
19+
# PLUGINS_GITHUB_TOKEN=<github token>
20+
### end Plugin installation
21+
```
22+
123
## Plugin installation using the cli
224

325
```bash

0 commit comments

Comments
 (0)