Quick Start

Table of Contents
The quickest path to encrypt and decrypt your first file. No payment details required.

Create an account, download OmegaSafe CLI from OmegaSafe Cloud, connect it, create a key, and encrypt your first file. A free trial (30 days) starts automatically with full features. After it expires, your account will move to a free tier. You will always be able to decrypt your files and keep your keys. You can start billing at any later point to restore full features.

1. Register and Activate Your Account
#

Go to OmegaSafe Cloud and complete the registration form. After registering, OmegaSafe sends an activation email to the address you provided. Open the link in that email to activate your account. Once activated you can sign in.

If the activation email does not arrive in 5 minutes, register again (same email address) to request a new activation email. For the full API-level registration and activation flow, see OmegaSafe API — Users API.

2. Generate an API Key
#

API keys provide long-lived authentication for OmegaSafe CLI. The navigation path in OmegaSafe Cloud is:

  1. Sign in to OmegaSafe Cloud.
  2. Open My Account.
  3. Go to Security.
  4. In API Key Management, create a key with the scopes you need.

When creating the key, follow the UI guidance on which scopes are needed for OmegaSafe CLI. See OmegaSafe API — API Key Scope Table for the full scope reference.

The plaintext API key is shown only once when it is created. Store it securely before leaving that page — you cannot retrieve it later.

3. Download OmegaSafe CLI
#

Download the OmegaSafe CLI binary or source package from OmegaSafe Cloud:

  1. Sign in to OmegaSafe Cloud.
  2. Open Download in the signed-in navigation.
  3. Select CLI.
  4. Choose a platform tile for the binary download, or select Source Code for the source package.

4. Initialize OmegaSafe CLI
#

Run omegasafe init to create local configuration files and set up connection to OmegaSafe Cloud.

omegasafe init

On a first-time setup, the command creates the default local configuration directory, initializes the protected local files, and then walks you through a short interactive setup:

  • Confirm that you want to add the default OmegaSafe Cloud connection now.
  • Accept the suggested connection name, OmegaSafe Cloud.
  • Accept the suggested service URL.
  • Paste the API key you generated earlier.

When those prompts finish, the CLI saves the connection locally and you can continue to key creation. For the External Claims Storage overview and the alternative post-init setup path, see Encryption Method — External Claims Storage.

For the full configuration-root behavior and complete command reference, see OmegaSafe CLI — Configuration Root And Init and OmegaSafe CLI — init.

5. Create Your First Key
#

Create your first OmegaSafe encryption key with:

omegasafe create-key

Interactive prompting with recommended defaults will guide you through. For the full command reference, interactive options, and key-configuration presets, see OmegaSafe CLI — create-key. The new key UUID will be printed out. To view your local keys later use:

omegasafe list-keys

For the full command reference and structured-output details, see OmegaSafe CLI — list-keys.

What create-key does
#

  • Creates the local Alpha key iteration.
  • Sets up cache scaffolding.
  • Registers the key metadata in OmegaSafe Cloud.
  • Creates and uploads the first Delta as an Alpha-encrypted payload.

For the Alpha/Delta model behind this flow, see Encryption Method — Alpha and Delta Split.

6. Encrypt and Decrypt a File
#

Encrypt
#

omegasafe encrypt --key-uuid YOUR_KEY_UUID --input-file ./notes.txt --output-dir ./encrypted

The default output filename is a random UUID with the .omegasafe extension. To override the output filename, pass --file-name-override. The override can use any filename and extension.

For the full command reference and available options, see OmegaSafe CLI — encrypt.

Decrypt
#

omegasafe decrypt --input-file ./encrypted/YOUR_FILE.omegasafe --output-dir ./restored

Decryption restores the original filename by default. To override the restored filename, pass --file-name-override.

For the full command reference and available options, see OmegaSafe CLI — decrypt.

Next Steps
#