Skip to content

braxiushq/cipher

Repository files navigation

Cipher

The encrypted cloud storage from your terminal.

Screenshot From 2026-05-06 17-25-29 cipher

License

Cipher is an interactive terminal client for secure cloud storage, built with Ink and Bun. All encryption happens locally on your machine — the server never sees your data or filenames.

Quick Install

curl -sL https://raw.githubusercontent.com/braxiushq/cipher/main/install.sh | bash

Table of Contents

Overview

Cipher lets you upload, download, and manage files in the cloud with true zero-knowledge encryption. Every file and all metadata (including filenames) is encrypted before leaving your machine. The server stores only encrypted blobs — it has no knowledge of what you are storing.

Built as a fully interactive TUI (terminal user interface) — no GUI required.

Security Model: Zero-Knowledge Encryption

Cipher implements strict end-to-end encryption. Your data is encrypted locally before it ever reaches the network.

  • Account Keys: Argon2id key derivation generates local master keys from your password. The server never receives your password or derived keys.
  • File Encryption: Each file is encrypted with a unique AES-256-GCM key. That file key is then encrypted with a Libsodium asymmetric public key, so only you can decrypt it.
  • Metadata: File and folder names are AES-256-GCM encrypted. The server stores only ciphertext — zero knowledge of your file structure or contents.

Features

  • E2EE file upload and download (streaming, chunked AES-256-GCM)
  • Encrypted folder creation, rename, and deletion
  • Encrypted metadata (filenames are never exposed to the server)
  • Interactive terminal UI with keyboard navigation
  • OTP-based authentication
  • Self-upgrade mechanism
  • Support for large files via streaming encryption (no memory bloat)

Installation

Requirements

Platform Architecture Status
Linux x64 (amd64), ARM64 (aarch64) Tested on Ubuntu, Debian, Fedora, Raspberry Pi 4+
macOS Apple Silicon (M1/M2/M3/M4) Not yet tested

One-Line Installer

curl -sL https://raw.githubusercontent.com/braxiushq/cipher/main/install.sh | bash

From Source (Requires Bun)

git clone https://github.com/braxiushq/cipher.git cipher
cd cipher
bun install
bun run dev

Usage

Launch Cipher by running:

cipher

Commands

Command Description
version Show the version number
help Show the help message
upgrade Update to the latest version
uninstall Completely remove Cipher and all local data

Options

Flag Description
--reset Reset configuration and clear local authentication
--clear-auth Clear authentication state only
--api-url <url> Override the default API URL

Development

bun install
bun run dev         # Run in development mode
bun run typecheck   # Type-check with TypeScript
bun run lint        # Lint and auto-fix with Biome
bun run format      # Format code with Biome

Contributing

To ensure stability and a focused roadmap, feature contributions and large refactors are not accepted at this time. Bug reports, issues, and bug fix PRs are welcome.

License

This project is licensed under the AGPL-3.0 License. See the LICENSE file for details.