Skip to main content

obsideo-cli

Client-side encrypted storage: your content is encrypted on your machine before upload, so the platform cannot read it. File and folder names are encrypted too, by default (AES-SIV, keyed off your data key), so the platform sees opaque tokens rather than your filenames. Save, browse, and sync whatever you want from your terminal. Files are encrypted on your machine before they leave, so Obsideo's gateway, coordinator, and storage providers only ever see ciphertext. Your data lands on three providers (RF=3).

pip install obsideo-cli
obsideo login    # email -> 8 GB free
obsideo          # open the shell

Get started

$ obsideo login
Enter your email: you@example.com
Check your email for a verification code.
Enter verification code: 482913
You're all set. 8 GB free.

Login is handled by Obsideo's signup service at signup.obsideo.io: it emails you a one-time code and provisions your free tier: 8 GB, no card, no expiry, and 16 GB after you answer eight questions in the Drive web app. There's no password - just your email and a local key (see How it works).

Then either drop into the shell or run one-shot commands:

$ obsideo
obsideo:/ put ~/notes.txt
obsideo:/ ls
  [file] notes.txt  1.2 KB
obsideo:/ put ~/photos                       # a whole folder, uploaded recursively
obsideo:/ put "C:\My Files\tax return.pdf"   # paths with spaces: just quote them
obsideo:/ mkdir trip
obsideo:/ cd trip
obsideo:/trip/ put ~/cat.jpg
obsideo:/trip/ get cat.jpg ./downloaded.jpg

Commands

Command Description
obsideo login Sign up / log in with your email (8 GB free)
ls [path] List files and folders
cd <path> / pwd Move around / show location
put <local> [name] Encrypt + upload a file, or a whole folder (recursive). --no-encrypt to store as-is
get <remote> [local] Download + decrypt a file
rm <remote> Delete a file
mkdir <name> Create a folder
info <remote> Show object metadata
account Show storage used vs. your free quota
key status|export|import Back up or restore your encryption key (see below)
sync push|pull|status Sync your local folder with Obsideo
config [set k v] Show or change settings

Using it on more than one machine

Your files are encrypted with a key generated on your machine and held only there. A second machine that logs in without that key gets a new one, and your existing files stay unreadable on it (they show as ? in ls). Nobody can reissue the key for you, us included.

So before you need it:

obsideo key export          # prints the line to save, or: key export ~/obsideo-key.txt

Then on the other machine, before uploading anything:

obsideo key import OBSIDEO_DATA_KEY=...
obsideo key status          # same fingerprint on both = both can read the same files

key status prints a fingerprint, not the key, so it is safe to compare over any channel. Importing over an existing key needs --force, because it makes whatever the old key protected unreadable.

How it works

obsideo is a thin front-end over the shared obsideo_core layer (storage seam, signing identity, account crypto, email-OTP login). The mlvault ML extension builds on the same core - build the core once, two front-ends.

  • Encryption: AES-256-GCM with one account data key held locally at ~/.obsideo/data.key. Copy that key to another machine and everything is readable there; lose it and the data is unrecoverable by design. Back it up.
  • Signing identity: an Ed25519 key (~/.obsideo/signing.key) authorizes deletes (Principle 2 - the network can't delete your data without your signature). Generated locally; only the public half is ever sent.
  • Filename encryption: on by default (encrypt_names). Each path component (folder names + filename) is encrypted on your machine with AES-SIV - deterministic, so ls/cd still list under the encrypted prefix and the client decrypts the returned tokens back to real names. Turn it off with config set encrypt_names false (interop/debug; existing objects aren't migrated).
  • What Obsideo sees: ciphertext only - never a filename or a byte of content. Residual leaks (by design at this level): directory structure (depth, fan-out), object sizes (ciphertext ≈ plaintext), and object counts. Identical names encrypt to identical tokens, so Obsideo can tell two objects share a name - never what it is.

License

MIT

Metadata

Release files for obsideo-cli 0.6.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for obsideo-cli 0.6.2
File Size Uploaded Provenance Actions
obsideo_cli-0.6.2.tar.gz 44.3 kB Without provenance Details for obsideo_cli-0.6.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for obsideo-cli 0.6.2
File Interpreter ABI Platform Actions
obsideo_cli-0.6.2-py3-none-any.whl Python 3 none any Details for obsideo_cli-0.6.2-py3-none-any.whl

Total release size: 82.6 kB

Release files / obsideo_cli-0.6.2.tar.gz

Download URL obsideo_cli-0.6.2.tar.gz
Size 44.3 kB
Tags Source
SHA-256 checksum
How to use checksums
00d8d8ada0c7d277c170b7a8e85e765105905d84188786d21e2c86866ccd3341
BLAKE2b-256 checksum
How to use checksums
35218f086e0997e0b8da61ee1e4c4a2610f4c48c34af37bdd91ea06bdd31d01d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.7

Release files / obsideo_cli-0.6.2-py3-none-any.whl

Download URL obsideo_cli-0.6.2-py3-none-any.whl
Size 38.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
34320bbb55eccb7ebeba1d6a08f9b6aff7b9a9a4976716147a1ec276358bbe70
BLAKE2b-256 checksum
How to use checksums
9d35bad46f574240fd7764e761cee6a75fd1a9ad786e29f00d7f3ec0a35f197b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.7

Security for obsideo-cli 0.6.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page