/internxt-cli

python command line client for internxt, includes webdav server

Primary LanguagePythonGNU Affero General Public License v3.0AGPL-3.0

Internxt Python CLI

A Python implementation of the Internxt CLI for encrypted cloud storage with path-based operations and a built-in WebDAV server.

✨ Features

🌐 WebDAV Server

  • ✅ Mount as a local drive: Access your Internxt Drive directly from Finder, File Explorer, or any WebDAV client.
  • ✅ Cross-platform support: Works on Windows, macOS, and Linux.
  • ✅ Stable and Compatible: Uses waitress (or cheroot, but buggy) for the best client compatibility.

🛣️ Path-Based Operations

  • ✅ Human-readable paths: Use /Documents/report.pdf instead of UUIDs.
  • ✅ Wildcard search: Find files with *.pdf, report*, etc.
  • ✅ Tree visualization: See your folder structure at a glance.
  • ✅ Path navigation: Browse folders like your local filesystem.

🔐 Core Functionality

  • ✅ Secure authentication: Login/logout with 2FA support.
  • ✅ File operations: Upload, download with progress indicators.
  • ✅ Folder management: Create and organize folders.
  • ✅ Zero-knowledge encryption: AES-256-CTR client-side encryption.

🚀 Quick Start

# Install dependencies
pip install -r requirements.txt

# Login to your account
python cli.py login

# Mount your drive locally! (EASIEST WAY TO USE)
python cli.py webdav-start

# Or, use path-based commands
python cli.py list-path
python cli.py find "*.pdf"
python cli.py download-path "/Documents/important.pdf"

📖 Complete Usage Guide

🔐 Authentication

# Login with interactive prompts
python cli.py login

# Login non-interactively
python cli.py login --email user@example.com --password mypass --2fa 123456

# Check current user
python cli.py whoami

# Logout and clear credentials
python cli.py logout

🌐 WebDAV Server

Mount your Internxt Drive as a local disk.

# Start the WebDAV server (it will print the URL and credentials)
python cli.py webdav-start

# Start in the background
python cli.py webdav-start --background

# Check if the server is running
python cli.py webdav-status

# Stop the server
python cli.py webdav-stop

# Show mount instructions for your OS
python cli.py webdav-mount

# Test if the server is responding correctly
python cli.py webdav-test

After starting, open your file manager (Finder/File Explorer) or Client (like CyberDuck) and connect to the server at http://localhost:8080 with username internxt and password internxt-webdav.

🛣️ Path-Based Operations

Navigate & List

# List root folder with readable paths
python cli.py list-path

# Navigate to specific folders
python cli.py list-path "/Documents"
python cli.py list-path "/Photos/2023/Summer"

# Show detailed information
python cli.py list-path "/Documents" --detailed

Search & Find

# Find files with wildcards
python cli.py find "*.pdf"              # All PDF files
python cli.py find "report*"            # Files starting with "report"

# Search in specific locations
python cli.py find "*.jpg" --path "/Photos"

Visual Navigation

# Show folder structure as tree
python cli.py tree
python cli.py tree "/Projects" --depth 2

Download Files

# Download by path (much easier!)
python cli.py download-path "/Documents/report.pdf"
python cli.py download-path "/Photos/vacation.jpg" --destination ~/Downloads/

🗑️ Delete & Trash Operations

Move to Trash (Recoverable)

# Move to trash by path
python cli.py trash-path "/OldDocuments/outdated.pdf"
python cli.py trash-path "/TempFolder"

Permanent Delete (⚠️ Cannot Be Undone)

# Permanently delete by path (with warnings)
python cli.py delete-path "/TempFile.txt"

📁 Traditional Operations (UUID-based)

# List folders (old way with UUIDs)
python cli.py list
python cli.py list --folder-id <folder-uuid>

# Create folders
python cli.py mkdir "My New Folder"

# Upload/Download by UUID
python cli.py upload ./document.pdf
python cli.py download <file-uuid>

🔧 Utility Commands

# Show current configuration
python cli.py config

# Test CLI components
python cli.py test

# Extended help with examples
python cli.py help-extended

# Debug path resolution
python cli.py resolve "/Documents/report.pdf"

📦 Installation

# Clone the repository
git clone [https://github.com/internxt/python-cli.git](https://github.com/internxt/python-cli.git)
cd python-cli

# Install dependencies
pip install -r requirements.txt

# For the best WebDAV experience, install 'waitress'
pip install waitress

# Start using immediately
python cli.py login
python cli.py webdav-start

Requirements

  • Python 3.8+
  • Dependencies: cryptography, mnemonic, tqdm, requests, click, WsgiDAV
  • WebDAV Server: waitress (recommended) or cheroot

🔒 Security & Privacy

This CLI implements the same security model as official Internxt clients:

  • Client-side encryption: All files encrypted on your device before upload (AES-256-CTR).
  • Zero-knowledge: Internxt servers never see your unencrypted data or keys.
  • Secure Credentials: Encrypted and stored locally in ~/.internxt-cli/.

🏗️ Development

Project Structure

internxt-cli/
├── cli.py                    # Main CLI interface with all commands
├── config/
│   └── config.py             # Configuration management
├── services/
│   ├── auth.py               # Authentication & login
│   ├── crypto.py             # Encryption/decryption
│   ├── drive.py              # Drive operations & path resolution
│   ├── webdav_provider.py    # WsgiDAV provider for Internxt
│   └── webdav_server.py      # WebDAV server management
└── utils/
    └── api.py                # HTTP API client

Development Setup

# Clone and setup development environment
git clone [https://github.com/internxt/python-cli.git](https://github.com/internxt/python-cli.git)
cd python-cli

# Create virtual environment
python -m venv venv
source venv/bin/activate  # Linux/macOS

# Install in development mode
pip install -e .
pip install -r requirements.txt

Getting Help

python cli.py --help
python cli.py help-extended
python cli.py <command> --help

📄 License

AGPL-3.0 license

Made with ❤️ for the Internxt community