The official, high-performance command-line interface for the myCloud ecosystem.
mycloudctl is the official command-line interface for myCloud. Built for power users, developers, and system administrators, the CLI provides seamless terminal access to the distributed myCloud storage platform. It translates complex API interactions into intuitive, fast, and secure terminal commands.
- Terminal UI (TUI): Beautiful, color-coded terminal interfaces built with
Rich, featuring live progress bars, dynamic tables, and tree views. - Robust Argument Parsing: Built on top of
Typerfor strict type-checking, intuitive subcommands, and auto-completion generation. - Asynchronous Operations: Efficient handling of bulk file uploads, downloads, and batch sharing.
- Standalone Binaries: Available as a standard Python package via PyPI or as a zero-dependency standalone executable compiled with
PyInstaller. - Node Management: Native commands to register and manage your private myCloud storage nodes directly from the terminal.
mycloudctl allows users to perform all myCloud operations without leaving their terminal. From basic file operations (ls, upload, download, rm) to advanced ecosystem features (stash, batch share, nodes), everything is one command away.
Developers, Linux enthusiasts, and server administrators who prefer scriptable, keyboard-driven workflows over graphical interfaces.
- Speed & Efficiency: Commands should be short, memorable, and execute instantly.
- Visual Clarity: Terminal output shouldn't be boring.
mycloudctlheavily utilizes colors, emojis, and structured tables to make data readable. - Security: Credentials must be handled securely via robust local authentication flows.
The CLI acts as a thick client, managing local state and communicating with the myCloud Control Plane via a RESTful API facade.
graph TD
subgraph "Local Environment (User Machine)"
CLI[mycloudctl CLI<br/>Typer / Rich]
Cred[(~/.mycloud/credentials.json)]
FS[Local Filesystem]
end
subgraph "myCloud Infrastructure"
CP[myCloud Control Plane<br/>Flask / Oracle Cloud]
Nodes[Distributed Storage Nodes]
end
CLI <-->|Reads/Writes Token| Cred
CLI <-->|Reads/Writes Files| FS
CLI <-->|HTTPS REST API| CP
CP <-->|Routes Storage| Nodes
- Authentication State:
mycloud loginsecurely exchanges credentials for an API token, storing it in~/.mycloud/credentials.json. Subsequent commands automatically inject this token into theAuthorizationheader. - Modular Command Groups: Commands are grouped logically (e.g.,
mycloud files,mycloud stash,mycloud share) using Typer sub-applications for maintainability. - API Facade: The CLI relies heavily on the
mycloud-sdkcore logic, serving primarily as a UI layer to translate user input into SDK function calls.
Navigate your cloud storage as if it were a local directory.
mycloud ls [folder_id]- Browse files in dynamic, color-coded tables.mycloud upload <file> [--node <node_id>]- Upload files with real-time progress bars.mycloud download <file_id>- Download files efficiently.mycloud mv,mycloud rm,mycloud rename- Standard POSIX-like commands.
Manage your hidden, temporary stash lifecycle.
mycloud stash add <id>- Move a file to the stash.mycloud stash ls- View stashed files.mycloud stash empty- Permanently clear the stash.
Generate secure links and manage batch sharing groups.
mycloud share link <id>- Generate a public URL.mycloud batch link- Create a bundle link for multiple files.
Manage your self-hosted storage nodes.
mycloud servers ls- List connected nodes.mycloud servers add- Generate an API key to register a new machine.
mycloud login: Sign in to your myCloud account.mycloud logout: Sign out and clear your current session.mycloud whoami: Display the currently logged-in user and session details.mycloud register: Register a new myCloud account directly from the terminal.
mycloud ls [folder_id] [--node <node_id>]: List files and folders.mycloud upload <file> [--node <node_id>]: Upload a local file. (Use--stashto upload it directly to your stash).mycloud download <id>: Download a specific file by its ID.mycloud download-all [folder_id] [--node <node_id>]: Download all files in a folder (or all files on a specific node).mycloud rm <id>: Delete a file.mycloud rm-all [folder_id] [--node <node_id>]: Delete all files in a folder (or wipe a specific node).mycloud rename <id> <new_name>: Rename an existing file.mycloud mv <id> <folder_id>: Move a file into a different folder.mycloud info <id>: Show detailed metadata for a file (size, creation date, type, etc.).mycloud cat <id>: Print the contents of a text file directly to the terminal.mycloud favorite <id>(ormycloud fav <id>): Toggle the favorite status of a file.
mycloud mkdir <name>: Create a new folder.mycloud rmdir <id>: Delete a folder.mycloud folders ls: List all your folders.mycloud folders rename <id> <new_name>: Rename a folder.
mycloud find <query>: Search your entire cloud for files and folders matching the name.
mycloud stash ls: List all items currently in your stash.mycloud stash restore <id>: Restore a stashed item back to its original location.mycloud stash empty: Empty the stash permanently, deleting files forever.
mycloud share create <file_id>: Create a shareable link for a file.mycloud share ls: List all your currently active shared items.mycloud share rm <share_id>: Revoke and remove a share link.mycloud share direct <file_id> <username>: Directly share a file with another registered myCloud user.
mycloud batch create: Create a new batch share link.mycloud batch add <batch_id> <file_id>: Add a file or folder to an existing batch share.
mycloud servers ls: List all your registered private storage nodes and their statuses.mycloud servers add: Register a new private storage node and generate its API key.mycloud servers rm <node_id>: Remove a registered private storage node.
mycloud stats(ormycloud storage stats): Show current storage usage, total capacity, and limits.mycloud storage breakdown: View a detailed breakdown of your storage consumption by file type.
mycloud notify ls: List your recent account notifications.mycloud notify read <id>: Mark a specific notification as read.mycloud notify read-all: Mark all pending notifications as read.
mycloud profile view: View your profile information.mycloud profile update-avatar <image_path>: Set or update your profile picture.mycloud prefs ls: Show your current user preferences.mycloud prefs set <key> <value>: Update a specific preference.
| Category | Technology |
|---|---|
| Language | Python 3.10+ |
| CLI Framework | Typer (Click) |
| Terminal UI | Rich |
| HTTP Client | HTTPX |
| Packaging | PyInstaller, setuptools, build |
- State Management in Stateless CLI: Designing an authentication flow that securely persists JWT tokens across isolated terminal command executions.
- Binary Compilation: Configuring
PyInstaller.specfiles to properly bundle hidden imports dynamically required byTyperandRich, ensuring the standalone.exeruns without Python installed. - Chunked Transfers: Implementing reliable, visually accurate progress bars using
Rich.Progresswhile streaming large file uploads/downloads viaHTTPXwithout loading the entire file into RAM.
IMPORTANT NOTICE: This repository is intended exclusively as a project showcase and portfolio piece.
To protect proprietary business logic and the core source code, the actual application logic is not published here. This README serves to demonstrate the architectural design and professional standards applied during the development of the myCloud CLI.
- Email: kanhaiffco2007@gmail.com
- LinkedIn: linkedin.com/in/rudransh-shekhar
- Portfolio: rudransh-shekhar.netlify.app
- PyPI Package: mycloudctl
- Live Platform: cloud.mysphere.co.in
- Ecosystem Hub: mysphere.co.in
- GitHub: github.com/rudy-07
Built with passion and engineering rigor. © 2026