Skip to content

Commit ded20bc

Browse files
docs: clarify Sourcegraph endpoint/token are required, recommend env vars (#45)
Clarifies the help text for `--src-endpoint` and `--src-access-token` to state they are required (as either env var or CLI arg) and recommend setting the `SRC_ENDPOINT` / `SRC_ACCESS_TOKEN` env vars. ## Checks run locally - ruff format / check: clean - pyright: 0 errors - unicode scan: clean - unittest: 107 passed Co-authored-by: Amp <amp@ampcode.com>
1 parent e61c843 commit ded20bc

1 file changed

Lines changed: 8 additions & 2 deletions

File tree

src/src_py_lib/clients/sourcegraph.py

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,10 @@ class SourcegraphClientConfig(Config):
160160
env_var="SRC_ENDPOINT",
161161
cli_flag="--src-endpoint",
162162
metavar="URL",
163-
help="Sourcegraph instance URL",
163+
help=(
164+
"Sourcegraph instance URL\n"
165+
"Required as either env var or arg. Recommended to set SRC_ENDPOINT env var"
166+
),
164167
help_group="Sourcegraph",
165168
required=True,
166169
)
@@ -169,7 +172,10 @@ class SourcegraphClientConfig(Config):
169172
env_var="SRC_ACCESS_TOKEN",
170173
cli_flag="--src-access-token",
171174
metavar="TOKEN",
172-
help="Sourcegraph access token, or op:// secret reference",
175+
help=(
176+
"Sourcegraph access token, or op:// secret reference\n"
177+
"Required as either env var or arg. Recommended to set SRC_ACCESS_TOKEN env var"
178+
),
173179
help_group="Sourcegraph",
174180
secret=True,
175181
required=True,

0 commit comments

Comments
 (0)