envelope Docs

The following docs exemplify the basic functionality of the envelope tool. The built-in --help is a good source of information. You may also find the unit tests in the tests directory useful.

• Overview of Commands — Adding subjects, assertions, signatures, and salt.
• Basic Examples — Demonstrating standard methodologies for entry, encryption, and signing.
• SSKR Example — Using Shamir's Secret Sharing to lock envelopes.
• Complex Metadata Example — Creating envelopes with layered, structured data.
• DID Document Example — Creating and wrapping identifiers.
• Verifiable Credential Example — Building complex credentials around an identifier.
• Verifiable Credential with Detailed Elision Example — Eliding some of a credential.
• Attachments — Standardized third-party attachments for envelopes.
• Signing Envelopes — Signing and verifying signatures on envelopes.
• CLI Key Formats — Inspecting key URs and native key interoperability.
• Multipart UR Examples — Splitting envelope URs into QR frames or animations.
• XID Documents — Overview of XID support.
  • XID Basics — Creating and identifying XID documents.
  • XID Export — Exporting with controlled private key handling.
  • XID Keys — Working with XID document keys.
  • XID Methods — Resolution methods.
  • XID Delegates — Working with delegates.
  • XID Services — Working with services.
  • XID Provenance — Provenance mark chains.
  • XID Signing — Signing and verifying.
  • XID Attachments — Third-party metadata.
  • XID Edges — Verifiable claims (edges).
• Pattern Matching - Using patterns to match on parts of envelopes
  • Envelope Pattern Expression Syntax - The syntax for envelope patterns used in pattern matching.

For more examples of envelope-cli usage, see the envelope-cli videos and their transcripts.