Skip to content

Commit 189004a

Browse files
Merge pull request #121 from kevinbackhouse/secret-advice
Update secrets advice
2 parents 574a3bd + 332d9e4 commit 189004a

File tree

1 file changed

+14
-5
lines changed

1 file changed

+14
-5
lines changed

README.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,17 +36,26 @@ Python >= 3.9 or Docker
3636

3737
## Configuration
3838

39-
Provide a GitHub token for an account that is entitled to use [GitHub Models](https://models.github.ai) via the `AI_API_TOKEN` environment variable. Further configuration is use case dependent, i.e. pending which MCP servers you'd like to use in your taskflows.
39+
Provide a GitHub token for an account that is entitled to use [GitHub Models](https://models.github.ai) via the `AI_API_TOKEN` environment variable. Further configuration is use case dependent, i.e. pending which MCP servers you'd like to use in your taskflows. In a terminal, you can add `AI_API_TOKEN` to the environment like this:
4040

41-
You can set persisting environment variables via an `.env` file in the project root.
41+
```sh
42+
export AI_API_TOKEN=<your_github_token>
43+
```
44+
45+
Or, if you are using GitHub Codespaces, then you can [add a Codespace secret](https://github.com/settings/codespaces/secrets/new) so that `AI_API_TOKEN` is automatically available when working in a Codespace.
46+
47+
Many of the MCP servers in the [seclab-taskflow](https://github.com/GitHubSecurityLab/seclab-taskflows) repo also need an environment variable named `GH_TOKEN` for accessing the GitHub API. You can use two separate PATs if you want, or you can use one PAT for both purposes, like this:
48+
49+
```sh
50+
export GH_TOKEN=$AI_API_TOKEN
51+
```
52+
53+
We do not recommend storing secrets on disk, but you can persist non-sensitive environment variables by adding a `.env` file in the project root.
4254

4355
Example:
4456

4557
```sh
46-
# Tokens
47-
AI_API_TOKEN=<your_github_token>
4858
# MCP configs
49-
GH_TOKEN=<your_github_token>
5059
CODEQL_DBS_BASE_PATH="/app/my_data/codeql_databases"
5160
AI_API_ENDPOINT="https://models.github.ai/inference"
5261
```

0 commit comments

Comments
 (0)