Skip to main content

ENC Client Documentation

Part of the ENC Ecosystem

📚 Read the Full Documentation PyPI License: MIT Python Platform

The ENC Client (enc-cli) is your secure gateway to the ENC ecosystem. It allows you to create, manage, and edit encrypted projects from your local machine, seamlessly integrating them with your favorite tools.

🚀 Installation

Prerequisites

  • Python 3.8+
  • pip
  • sshfs (Optional, required for mounting projects)

    Note: If mounting fails, please reinstall sshfs manually: brew install --cask macfuse && brew install sshfs or restore from backup.

Installation

The recommended way to install ENC Client is via pip:

pip install enc-cli

After installing, run the setup command to handle dependencies (like sshfs) and environment configuration:

enc install

This will:

  1. Check for sshfs and attempt to install it if missing.
  2. Configure your shell PATH if needed.
  3. Guide you to the next step (enc config init).

To verify installation:

enc --version

⚙️ Configuration

Before you can login, you need to tell the CLI where your server is located.

1. Initialize Config

Run the interactive configuration wizard:

enc config init

You will be asked for:

  • Server URL: The address of your ENC Server (e.g., http://myserver.com:2222).
  • Username: Your assigned username.
  • SSH Key Path: Path to your private SSH key (e.g., ~/.ssh/id_ed25519).

To view your current configuration:

enc show

2. SSH Key Setup

For a seamless experience, we recommend using an SSH agent or specifying your key in the config.

Using SSH Agent:

ssh-add -K ~/.ssh/my_enc_key

Using Config File: If you set the key path during enc config init, the CLI will automatically use it for all connections.


🔐 Workflow Guide

1. Login

Start your secure session. This establishes the encrypted tunnel.

enc login

2. Managing Projects

Create a New Project:

enc project init <project-name>
# You will be prompted to set a unique password for this project vault.

List Projects:

enc project list
# Shows all your projects and their mount status.

Remove a Project:

enc project remove <project-name>
# WARNING: This permanently deletes the encrypted vault from the server.

3. Editing Code (Mounting)

This is the magic of ENC. You can mount a remote encrypted project to a local folder.

mkdir ./my-work-folder
enc project mount <project-name> ./my-work-folder
# Enter project password when prompted

Once mounted:

  • Open ./my-work-folder in VS Code, Vim, or any editor.
  • Files you see are plaintext.
  • Files written to disk are instantly encrypted and saved on the server.

4. Logout

When you are done, logout to secure your session.

enc logout

Safety Feature: This command automatically detects and force-unmounts any active project connections to ensure no plaintext access remains.


🛡️ Client-Side Monitoring Protocols

The ENC Client employs active monitoring to ensure session security and clean resource management.

1. Project Integrity Monitor

  • Function: Continuously verifies that your local mount points are active and valid.
  • Behavior:
    • Checks status every 3 seconds.
    • If a mount point becomes invalid (e.g., directory deleted, connection dropped), it automatically triggers a forced unmount cleanup to remove stale handles.

2. Session Watchdog

  • Function: Ties your ENC session to your active terminal window.
  • Behavior:
    • Runs as a background process monitoring the Parent PID (your shell).
    • Auto-Logout: If you close your terminal window or the shell process terminates, the watchdog immediately triggers a full enc logout.
    • Signal Handling: Captures termination signals (SIGINT, SIGTERM, SIGHUP) to ensure sessions close gracefully even during unexpected shutdowns.

🛠 Command Reference

Command Description
enc config init Setup or update local configuration.
enc login Authenticate with the server.
enc logout Close session and unmount all projects.
enc user create (Admin) Create a new user account.
enc project init Create a new encrypted project vault.
enc project list View available projects.
enc project mount Mount a remote project locally via SSHFS.
enc project unmount Unmount a specific project.
enc status Check current session validity.

🗑 Uninstallation

To remove the CLI and its virtual environment:

./uninstall.sh

Metadata

Release files for enc-cli 0.1.5

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

Source distribution (sdist)

Source distribution for enc-cli 0.1.5
File Size Uploaded Provenance Actions
enc_cli-0.1.5.tar.gz 26.0 kB Without provenance Details for enc_cli-0.1.5.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for enc-cli 0.1.5
File Interpreter ABI Platform Actions
enc_cli-0.1.5-py3-none-any.whl Python 3 none any Details for enc_cli-0.1.5-py3-none-any.whl

Total release size: 54.4 kB

Release files / enc_cli-0.1.5.tar.gz

Download URL enc_cli-0.1.5.tar.gz
Size 26.0 kB
Tags Source
SHA-256 checksum
How to use checksums
d1b779797326dd4aab1db48bc90146c72c814d476168d00a1e443c8d84650653
BLAKE2b-256 checksum
How to use checksums
80357671e133d1fabfa29705fdb9f666a596c858b0870981b0605b87574a2934
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.14.2

Release files / enc_cli-0.1.5-py3-none-any.whl

Download URL enc_cli-0.1.5-py3-none-any.whl
Size 28.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9a60d66ea4e2939e567676ad187766ff5271217ae5e8a59636546a368154cd8e
BLAKE2b-256 checksum
How to use checksums
902b880f5257015797601805e7384ba54bee89370498021262e85ff8f01f97e4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.14.2

Security for enc-cli 0.1.5

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.

Release history Release notifications | RSS feed

This release

0.1.5 This release

2 release files No provenance

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