NOTE: Preview version. Not ready for production use.
To install the latest stable version from crates.io, run:
cargo install bc-envelope-cliTo install a specific version:
cargo install bc-envelope-cli --version 0.27.0When building from source, we strongly recommend building from a tagged release rather than the tip of the main branch, which may contain unstable code or breaking changes:
# Clone the repository
git clone https://github.com/BlockchainCommons/bc-envelope-cli-rust.git
cd bc-envelope-cli-rust
# List available tags
git tag -l
# Checkout the most recent tag
git checkout $(git describe --tags --abbrev=0)
# Install the tool
cargo install --path .If you must build from the main branch, be aware that it may have dependency mismatches or other issues:
# Build without installing (debug build)
cargo build
# Test before installing
cargo test
# If all tests pass, you can install
cargo install --path .Make sure your ~/.cargo/bin directory is in your PATH.
If you encounter build problems:
- Try debug build first:
cargo buildinstead ofcargo build --release - Check dependency versions: The main branch might require specific versions of dependencies
- Verify compatible Rust version: Run
rustc --versionto check your Rust version - Build from a release tag: Tagged releases have been tested and should build properly
For serious build issues, please open an issue on the GitHub repository with details about your environment and the errors you're seeing.
envelope --helpSee the docs directory for more information.
NOTE: The envelope tool does not have the same command line syntax as the Swift envelope tool.
- Add XID provenance mark support ('xid provenance get' and 'xid provenance next' commands).
- Add XID signing and verification support (--sign and --verify options).
- Update XID documentation.
- Align to dependencies.
- Add encryption support for provenance mark generator.
- Change default generator option to omit.
- Update bc-xid dependency to 0.15.1.
- Format.
- Align to dependencies.
- Replace generate signer/verifier commands with keypairs command.
- Add signing and encryption options to generate prvkeys.
- Add generator options to xid new command.
- Update documentation.
- Add walk subcommand for navigating and manipulating envelope nodes.
- Change terminology from uncompress to decompress.
- Fix provenance-mark tag registration bug.
- Align to dependencies.
- Fixed bug where the proper tag for provenance-mark was not being registered.
- Added support for ur:envelope seed format to the 'generate prvkeys --seed' command.
- Add walk replace subcommand.
- Add XID private key encryption support.
- Align to dependencies.
- Align to dependencies.
- Fix error handling in attachment vendor command.
- Fix error handling in SSH key generation.
- Fix error handling in SSKR split operation.
- Fix error handling in XID document operations.
- Align to dependencies.
- Align to dependencies.
- Updated to latest envelope patex syntax
- Integrated dcbor patex matching
- Add new pattern matching tests and test utilities
- Fix Date type references in extract command
- Update extensive documentation
- Fixed bug that would cause a crash when finding assertions that have their own assertions.
- Maintenance release.
- Maintenance release.
- Added support for XID Document Services.
- Endpoints in XID keys are now deprecated in favor of services.
- Started adding support for XID Documents.
- Anywhere in
envelopethat accepts aur:envelopecan also accept any other UR types containing envelopes, including XID documents.
- Aligned to dependencies.
- Schnorr signatures are now BIP-340 compliant.
- Fixed bug that would cause certain valid combinations of SSKR shares to be rejected.