Skip to content

README.md

Latest commit

 

History

History
64 lines (43 loc) · 3.07 KB

README.md

File metadata and controls

64 lines (43 loc) · 3.07 KB
Raw

ShellKrypt

ShellKrypt is a local-only encrypted vault for individuals who want to manage credentials, project secrets, authenticator codes, cards, and notes in user-controlled files without a cloud account. Its first useful workflow is creating a local vault and storing an encrypted record.

Status

  • Stage: active pre-1.0 development.
  • Status note: Desktop workflows are functional, but packaging, mobile parity, and public-release validation are incomplete.
  • Main audience: Developers and privacy-conscious individuals who prefer local encrypted storage.
  • Maintainer: Independent project owner.

Highlights

  • Stores sensitive item payloads and vault-scoped activity details encrypted in local .skvault files.
  • Provides dedicated workspaces for Web Logins, Credit Cards, API Keys, Project Secrets, Authenticator, Markdown Notes, Security Audit, backups, and Crypto Tools.
  • Requires no ShellKrypt cloud account, hosted synchronization service, telemetry service, or remote recovery provider.

Requirements

  • .NET 10 SDK.
  • Windows or Linux desktop environment supported by Avalonia for current desktop development.
  • Android or iOS workloads only when building the optional mobile platform heads.

Quick Start

dotnet restore ShellKrypt.slnx
dotnet run --project src/ShellKrypt.Desktop/ShellKrypt.Desktop.csproj

Full setup, build, test, and platform commands are documented in the private development guide used by maintainers.

Example

Create and reopen an encrypted vault
Input or action: Create a local vault, choose a master password, and add a web login.
Result: ShellKrypt encrypts the item in the .skvault file and restores it after a successful lock and unlock cycle.

Limitations

  • ShellKrypt is pre-1.0, has not received an external security audit, and should not be treated as a certified regulated-data platform.
  • Quick Fill remains unfinished, and native Wayland Auto-Type is not supported.
  • Mobile apps, code signing, installers, update delivery, and public support processes are not release-ready.

Security Or Privacy Notes

  • There is intentionally no password recovery. A forgotten master password or backup passphrase can make encrypted data permanently inaccessible.
  • Plaintext exports and clipboard values leave the encrypted vault boundary; clipboard clearing is best-effort.
  • ShellKrypt does not collect vault data through a ShellKrypt backend by default. Read SECURITY.md, PRIVACY.md, and DISCLAIMER.md before relying on the project.

License

Copyright (C) 2026 Akbulut55.

ShellKrypt is licensed under GPL-3.0-or-later. See LICENSE for details.

Notes

  • The current desktop application version is 0.19.1.
  • The official source repository is Akbulut55/ShellKrypt.
  • ShellKrypt.slnx is the canonical workload-neutral solution; Android and iOS heads build directly from their project files.
  • Official signed builds, distribution channels, support, names, and branding may be governed separately as described in NOTICE.md.