Repository navigation
feat(cli): add dotenv support, env var template, and bitcoind setup docs - #343
Closed
Olorunshogo wants to merge 1 commit into
Closed
Olorunshogo wants to merge 1 commit into
Olorunshogo wants to merge 1 commit into
Conversation
Olorunshogo
marked this pull request as ready for review
October 8, 2026 15:07
Member
|
NACK. This project already has a config file system so I don't see any need for this change. |
Collaborator
|
The project already uses toml files for managing configs. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR Summary
Summary
dotenvy = "0.15"and load.envat startup beforeenv_logger::init(). A missing.envstays silent; a malformed one logs awarn!instead of failing silently..env.example: new file documenting every environment variable the CLI reads, grouped by command area (global options, descriptors, backends, proxy, key management, transaction building, PSBT ops, Payjoin, logging)..gitignore: the entry was.env/, a directory-only pattern that never matched the.envfile itself. Changed to.env.README.md: document thebitcoind/bitcoin-cliprerequisite for therpcfeature and the Justfile workflow, with an install snippet and a note pointing at the official verification guide. Wirecp .env.example .envinto the install instructions and the regtest walkthrough. Fix the$(just address)footgun with an explicit note. Renumber the regtest steps sequentially after the new step was inserted.docs/summary.md: new capability reference doc covering all commands, backends, and setup paths.Notes to the reviewers
dotenvy::dotenv()'g.envstays silent(the common case), but amalformed one now lor::init()` runs, instead of failing silently.
.env.examplecover value insrc/,includingPOLICY/TYPEforthe
compilecommanble names match theexisting clap definitionsas-is; renaming themeaking anyone alreadyusing them as shell exports.
note pointing at thetion guide instead ofinlining the full steps.
Files changed
Cargo.toml/Cargo.lockdotenvy = "0.15"src/main.rs.env.example.gitignore.envfrom being trackedREADME.md.envonboarding, step fixesTest plan
cargo buildandcargo build --features rpcsucceed without new warningscp .env.example .env, setNETWORK=regtest, runbdk-cli wallet -w <name> balancewithout-nand confirm the network resolves correctly.envand confirm awarn!log appears and the app still startsgit check-ignore -v .envreturns.gitignore:.envREADME.mdend to endChecklists
cargo fmtbefore committingNew Features: