Skip to content

Commit e4c87b1

Browse files
author
Gerit Wagner
committed
update docs/key management
1 parent 62b6ecd commit e4c87b1

6 files changed

Lines changed: 26 additions & 0 deletions

File tree

colrev/packages/genai/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@ To set the open-AI key, run
1414
export OPENAI_API_KEY="your_api_key_here"
1515
```
1616

17+
To keep the key available in future shell sessions, append the ``export`` line
18+
to your shell profile (for example ``~/.bashrc``) and reload it with
19+
``source ~/.bashrc``.
20+
1721
## prescreen
1822

1923
Note: This document is currently under development. It will contain the following elements.

colrev/packages/scopus/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ Get an API key and set it using
1414
export SCOPUS_API_KEY="your-api-key"
1515
```
1616

17+
> **Tip:** To keep the key for future sessions, append the export line to your shell profile (for example ``~/.bashrc``) and reload it with ``source ~/.bashrc``.
18+
1719
## Links
1820

1921
- [Scopus](http://www.scopus.com)

colrev/packages/springer_link/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,10 @@ Set the API-KEY using
6363
export SPRINGER_API_KEY="your-api-key"
6464
```
6565

66+
> **Tip:** Add the export line to your shell profile (for example ``~/.bashrc``)
67+
> and reload it with ``source ~/.bashrc`` to keep the key available in future
68+
> sessions.
69+
6670
The user can choose between `complete_search_string` for searching with a complex query or `interactively` to enter search parameters interactively.
6771

6872
#### API search: complex query

docs/source/manual/packages/colrev.genai.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,10 @@ To set the open-AI key, run
8080
8181
export OPENAI_API_KEY="your_api_key_here"
8282
83+
For a permanent configuration, append the ``export`` statement to your shell
84+
profile (for example ``~/.bashrc``) and reload it using
85+
``source ~/.bashrc`` so the key is available in future sessions.
86+
8387
prescreen
8488
---------
8589

docs/source/manual/packages/colrev.scopus.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,12 @@ Get an API key and set it using
6868
6969
export SCOPUS_API_KEY="your-api-key"
7070
71+
.. note::
72+
73+
Add the ``export`` command to your shell profile (for example ``~/.bashrc``)
74+
and reload it with ``source ~/.bashrc`` to keep the key available across
75+
sessions.
76+
7177
Links
7278
-----
7379

docs/source/manual/packages/colrev.springer_link.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,12 @@ Set the API-KEY using
118118
119119
export SPRINGER_API_KEY="your-api-key"
120120
121+
.. note::
122+
123+
To keep the API key available across terminal sessions, append the
124+
``export`` command to your shell profile (for example ``~/.bashrc``) and
125+
reload it with ``source ~/.bashrc``.
126+
121127
The user can choose between ``complete_search_string`` for searching with a complex query or ``interactively`` to enter search parameters interactively.
122128

123129
API search: complex query

0 commit comments

Comments
 (0)