Skip to content

Commit 6580981

Browse files
committed
docs
1 parent e7cc199 commit 6580981

File tree

2 files changed

+19
-2
lines changed

2 files changed

+19
-2
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: Bug report
3-
about: Create a report to help us improve
3+
about: Create a report to help us improve ECA
44
title: ''
55
labels: bug
66
assignees: ''
@@ -22,6 +22,9 @@ Steps to reproduce the behavior:
2222
**Expected behavior**
2323
A clear and concise description of what you expected to happen.
2424

25+
**Doctor**
26+
Paste the relevant parts of `/doctor` command in chat if applicable:
27+
2528
**Screenshots**
2629
If applicable, add screenshots to help explain your problem.
2730

docs/troubleshooting.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,24 @@ ECA works with clients (editors) sending and receiving messages to server, a pro
1010

1111
## Missing env vars
1212

13-
Some editors are started with empty shell especially on MacOS, you can check if the env vars are available via `/doctor`.
13+
When launching editors from a GUI application (Dock, Applications folder, or desktop environment), high chance that it won't inherit environment variables from your shell configuration files (`.zshrc`, `.bashrc`, etc.). Since the ECA server is started as a subprocess from editor, it inherits the editor environment, which may be missing your API keys and other configuration.
14+
15+
You can check if the env vars are available via `/doctor`.
1416

1517
One way to workaround that is to start the editor from your terminal.
1618

19+
### Alternatives
20+
21+
- Start the editor from your terminal.
22+
23+
- Set variables in your editor if supported, example in Emacs: `(setenv "MY_ENV" "my-value")`
24+
25+
- On macOS, you can set environment variables system-wide using `launchctl`:
26+
27+
```bash
28+
launchctl setenv ANTHROPIC_API_KEY "your-key-here"
29+
```
30+
1731
## Ask for help
1832

1933
You can ask for help via chat [here](https://clojurians.slack.com/archives/C093426FPUG)

0 commit comments

Comments
 (0)