Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docs): Add ELECTRIC_FEATURES environment variable to CLI #1320

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

msfstef
Copy link
Contributor

@msfstef msfstef commented Jun 4, 2024

To be merged once #1304 lands in main.

@samwillis
Copy link
Contributor

@msfstef @magnetised is there a docs PR for the new ELECTRIC_FEATURES env var? These cli docs for the env var should link to the docs for the server env var and how it can be used.

@msfstef
Copy link
Contributor Author

msfstef commented Jun 4, 2024

@samwillis you're right I don't see this in the docs anywhere but it is documented in code:

2. Via an env variable `ELECTRIC_FEATURES`. This uses a PATH-like syntax,
where flag settings are separated by colons, e.g. to add or update the
existing environment configuration with `another_feature` off and
`some_feature` on, you would do:
export ELECTRIC_FEATURES="another_feature=false:some_feature=true:${ELECTRIC_FEATURES:-}"
i.e. values at the start of the env variable have precedence.

@samwillis
Copy link
Contributor

@msfstef Maybe this PR can add both parts of the docs?

@msfstef
Copy link
Contributor Author

msfstef commented Jun 5, 2024

@samwillis I think it should but I'm hoping for someone more familiar with this flag to confirm it haha @magnetised @alco ?

I've added it tentatively here bbb8ea3

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants