vbantxt/CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Before any major/minor/patch bump all unit tests will be run to verify they pass.

[Unreleased]

[0.7.0] - 2026-04-25

Added

• --man flag for man page generation.

[0.6.0] - 2026-02-14

Added

• streamname length validation added to {packet} factory method.

Changed

• {packet}.bspIndex now defaults to indexOf(BpsOpts, 256000).
  • this doesn't affect the CLI which already defaulted to 256000.
• WithBPSOpt and WithChannel functional options now log at warn level if passed out of bounds value. They will fallback to valid defaults.

[0.5.0] - 2025-06-25

Added

• it's now possible to load configuration from environment variables. See Environment Variables
• --version/-v command

Changed

• shortname for --host flag is now -H.
• shortname for --channel flag is now -n.
• toml loader no longer requires a [connection] table. See TOML Config

[0.4.1] - 2025-04-05

Changed

• -loglevel flag is now of type string. It accepts any one of trace, debug, info, warn, error, fatal or panic.
  • It defaults to warn.

[0.3.1] - 2025-03-31

Fixed

• The CLI now uses os.UserConfigDir() to load the default config.toml, which should respect $XDG_CONFIG_HOME. See UserConfigDir

[0.2.1] - 2024-11-07

Fixed

• {packet}.header() now uses a reusable buffer.

[0.2.0] - 2024-10-27

Added

• config flag (shorthand C), you may now specify a custom config directory. It defaults to home directory / .config / vbantxt_cli /.
  • please note, the default directory has changed from v0.1.0
• Functional options WithRateLimit and WithBPSOpt and WithChannel added. Use them to configure the vbantxt client. See the included vbantxt cli for an example of usage.

Changed

• Behaviour change: if any one of "host", "h", "port", "p", "streamname", "s" flags are passed then the config file will be ignored.
• delay flag changed to ratelimit (shorthand r). It defaults to 20ms.

[0.1.0] - 2024-06-28

Added

• Matrix and Logging sections to README.

Changed

• host flag now defaults to "localhost". Useful if sending VBAN-Text to Matrix
• loglevel flag now expects values that correspond to the logrus package loglevels (0 up to 6). See README.
• Config values are only applied if the corresponding flag was not passed on the command line.

[0.0.1] - 2022-09-23

Added

• Initial release, package implements VBAN PROTOCOL TXT with a basic CLI for configuring options.
• Ability to load configuration settings from a config.toml.