Skip to content

arnonsang/vyn

Repository files navigation

vyn logo

vyn

Encrypted env/config sync CLI for teams. Helps you encrypt, sync, diff, share, and run environment/config files with a local-first workflow and optional relay/S3 storage.

crates.io vyn-cli crates.io vyn-core crates.io vyn-relay CI license

This project is under active development. Until v1.0.0 is released, any version bump may include breaking changes to the CLI interface, config file format, relay protocol, or storage layout. Pin your version if you depend on stable behavior.

Full documentation: vyn.iamick.dev

Highlights

  • AES-256-GCM encryption for all synced blobs and manifests
  • GitHub OAuth Device Flow identity (no passwords, no manual username entry)
  • SSH-based project key sharing via age - invite embeds vault ID, relay URL, and key so recipients onboard in one command
  • vyn.toml - non-secret public config committed to Git; enables zero-config vyn pull and vyn clone
  • One-step onboarding: vyn clone - finds invite, imports key, pulls all files
  • Opt-in .vynignore - track only what you explicitly include
  • Relay session token caching - no re-auth on every command after vyn auth
  • Self-hosted relay server with optional S3 mirroring

Install

Option A: crates.io (recommended)

cargo install vyn-cli

Option B: Pre-built binary

# Linux / macOS
curl -fsSL https://github.com/arnonsang/vyn/releases/latest/download/install.sh | sh

# Windows: download vyn-x86_64-pc-windows-msvc.zip from releases

Option C: Build from source

git clone https://github.com/arnonsang/vyn.git
cd vyn
cargo install --path crates/vyn-cli

See Installation for Docker build and uninstall options.

Quick Start

vyn init my-project   # create vault
vyn config            # configure relay storage
vyn auth              # GitHub OAuth + SSH verify
vyn push              # encrypt and upload
vyn pull              # download and decrypt

Join an existing vault

mkdir my-project && cd my-project
vyn clone https://relay.example.com <vault_id>

Project Layout

  • crates/vyn-core - crypto, keychain, manifest, storage, diff/merge, p2p
  • crates/vyn-cli - end-user CLI command surface
  • crates/vyn-relay - gRPC relay service implementation
  • proto/vyn.proto - relay API contract

Documentation

About

Encrypted env/config sync CLI for teams. Helps you encrypt, sync, diff, share, and run environment/config files with a local-first workflow and optional relay/S3 storage.

Resources

License

Stars

Watchers

Forks

Packages