In retrospect, I definitely regret placing the config file in $HOME/src-config.json -- that was silly of me. The src CLI was a quick 4hr hack project initially, and configuration was the most crufty piece of it. I briefly considered a hidden file but thought that would make it harder to discover for some naive reason.

Alternative proposal: Deprecate the config file entirely. I no longer believe it is the right method for configuring the src CLI because:

In scripting use cases, it is almost always the case that you will want to configure it with env variables. I have never once observed anyone prefer doing this via a config file.
In dev environment setups, configuring env variables is far easier and more familiar than writing config files in JSON.
The original motivation for using a config file was that "you might want to change the endpoint depending on the context you are working in (closed source vs. open source code)" but this is easier done with dotenv or similar.

This could be done by simply:

Undocumenting the -config flag
Ensuring the env variables work as expected and are documented in the README and anywhere else (check docs.sourcegraph.com).

@ryan-blunden Yes, src -h does report it:

[...]
The options are:
	-config=$HOME/src-config.json    specifies a file containing {"accessToken": "<secret>", "endpoint": "https://sourcegraph.com"}
[...]

Deprecate config file #156

Description

Metadata

Metadata

Assignees

Labels

Type

Fields

Projects

Milestone

Relationships

Development

Issue actions