https://github.com/karamble/brclientd
Headless Bison Relay daemon powering the dcrpulse BR integration
https://github.com/karamble/brclientd
Last synced: 17 days ago
JSON representation
Headless Bison Relay daemon powering the dcrpulse BR integration
- Host: GitHub
- URL: https://github.com/karamble/brclientd
- Owner: karamble
- License: isc
- Created: 2026-05-24T22:35:20.000Z (27 days ago)
- Default Branch: master
- Last Pushed: 2026-05-25T12:31:18.000Z (26 days ago)
- Last Synced: 2026-05-25T14:26:54.174Z (26 days ago)
- Language: Go
- Size: 168 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# brclientd
Headless [Bison Relay](https://github.com/companyzero/bisonrelay) daemon.
Wraps the BR `client` library behind a JSON-RPC surface (clientrpc) so any
application can integrate BR messaging without embedding the TUI or the
Flutter GUI.
Designed for projects that already operate an external `dcrlnd` and want
to add BR features through a clean network boundary.
## Status
Phase 1 skeleton. Connects to dcrlnd, prints `ready`, exits on SIGTERM.
clientrpc, identity creation, and the BR client core wire in later phases.
## Configuration
brclientd follows the Decred daemon conventions (dcrd / dcrwallet / dcrlnd):
CLI flags + an INI config file, parsed via
[`go-flags`](https://github.com/jessevdk/go-flags). Paths default to the
platform's standard application directory.
Default locations on Linux:
```
~/.brclientd/ application data root
~/.brclientd/brclientd.conf config file
~/.brclientd/data// BR client state (DB, msgs, downloads)
~/.brclientd/logs//brclientd.log
```
See `sample-brclientd.conf` for a documented config template.
Frequently used flags:
```
brclientd \
--appdata=/path/to/data-dir \
--dcrlnd.rpchost=127.0.0.1:10009 \
--dcrlnd.tlscertpath=~/.dcrlnd/tls.cert \
--dcrlnd.macaroonpath=~/.dcrlnd/data/chain/decred/mainnet/admin.macaroon
```
Run `brclientd --help` for the full list. All long-form flags are also
valid INI keys; sections map to flag groups (`[dcrlnd options]`,
`[clientrpc options]`).
## Build
```
go build ./cmd/brclientd
```
Container image:
```
docker build -t brclientd:dev .
```
## License
ISC. Copyright (c) 2015-2026 The Decred developers.