Spaces:
Running
Running
| title: Docs | |
| emoji: 🏢 | |
| colorFrom: indigo | |
| colorTo: green | |
| sdk: static | |
| pinned: false | |
| # ☁️ pockit CLI | |
| <p align="center"> | |
| <img src="scr.png" width="650" alt="pockit CLI Screenshot" /> | |
| </p> | |
| ## 🚀 Welcome to pockit | |
| Welcome to **pockit CLI**, a modern command-line tool built specifically for developers who want fast, direct access to their cloud files — without using a website. | |
| While the web platform is available at **[https://pockit-cloud.github.io/home](https://pockit-cloud.github.io/home)**, pockit CLI is designed for users who prefer working entirely in the terminal. It provides the same core file management capabilities in a faster, scriptable, and development-friendly environment. | |
| pockit lets you manage your storage directly from the command line. Upload, download, organize, delete, and synchronize files using simple commands, all inside a clean and interactive CLI experience. | |
| This tool is designed for developers, power users, and anyone who wants efficient cloud access without opening a browser. | |
| --- | |
| ## 🎯 Purpose of pockit | |
| pockit exists to: | |
| * Provide direct cloud file access from the terminal | |
| * Offer an alternative to using the web interface | |
| * Speed up developer workflows | |
| * Enable automation and scripting | |
| * Deliver a clean, interactive CLI experience | |
| * Support real-time folder synchronization | |
| It is built to integrate naturally into development environments, CI workflows, and everyday terminal usage. | |
| --- | |
| ## ✨ Key Features | |
| pockit combines powerful functionality with a polished interface. | |
| ### 🔐 Secure Session Handling | |
| * Interactive login system | |
| * Local session caching for convenience | |
| * Automatic reuse of saved sessions | |
| * Secure storage of credentials | |
| * Manual logout support | |
| ### 📂 Full File Management | |
| * List all files | |
| * Upload local files | |
| * Download files interactively | |
| * Delete files safely with confirmation | |
| * Change account password | |
| ### ✨ Magic Sync Mode | |
| * Continuous two-way synchronization | |
| * Detects new, modified, and removed files | |
| * Keeps a local folder and cloud storage identical | |
| * Runs until manually stopped | |
| * Cross-platform support | |
| ### 🎨 Modern Terminal Experience | |
| * Styled output using Rich | |
| * Interactive prompts | |
| * Spinners and progress bars | |
| * Clean tables and panels | |
| * Color-coded status messages | |
| --- | |
| ## 🖥️ Commands | |
| ### `pockit login` | |
| Start a secure session. | |
| ### `pockit logout` | |
| Clear saved session data. | |
| ### `pockit ls` | |
| List all files in your cloud storage. | |
| ### `pockit upload` | |
| Upload a local file to the cloud. | |
| * Interactive file selection | |
| * Optional rename | |
| * Progress feedback | |
| ### `pockit download` | |
| Download a selected cloud file. | |
| * Interactive selection | |
| * Choose save location | |
| * Validated before saving | |
| ### `pockit delete` | |
| Remove a file from cloud storage. | |
| * Requires confirmation | |
| * Prevents accidental deletion | |
| ### `pockit chpasswd` | |
| Change your account password securely. | |
| ### `pockit magicsync` | |
| Enable continuous synchronization between a local folder and your cloud storage. | |
| * Automatic updates both ways | |
| * Detects changes using file hashing | |
| * Stop anytime with `Ctrl + C` | |
| --- | |
| ## 📁 Magic Sync Folder | |
| Magic Sync uses a dedicated folder depending on your operating system: | |
| * **macOS & Windows:** Desktop → `Pockit-magicSync` | |
| * **Linux:** Uses system desktop directory if available, otherwise creates a folder in your home directory. | |
| This ensures a consistent sync location across platforms. | |
| --- | |
| ## 🔄 How Magic Sync Works | |
| Magic Sync continuously monitors both local and cloud files. | |
| It automatically: | |
| * Detects new files | |
| * Detects modified files | |
| * Detects deleted files | |
| * Applies updates in both directions | |
| * Keeps environments perfectly aligned | |
| This enables seamless development workflows and instant synchronization. | |
| --- | |
| ## 🏗️ Design Philosophy | |
| pockit is built with: | |
| * Developer-first thinking | |
| * Clean command structure | |
| * Cross-platform compatibility | |
| * Automation-friendly workflows | |
| * Interactive usability | |
| * Lightweight performance | |
| The goal is to make cloud file management fast, intuitive, and terminal-native. | |
| --- | |
| ## 🚀 Installation | |
| pockit is available on **PyPI** and can be installed directly with: | |
| ```bash | |
| pip install pockit | |
| ``` | |
| After installation, run it using: | |
| ```bash | |
| pockit <command> | |
| ``` | |
| Example workflow: | |
| ```bash | |
| pockit login | |
| pockit upload | |
| pockit ls | |
| pockit download | |
| pockit magicsync | |
| ``` | |
| --- | |
| ## 🔒 Security Overview | |
| * Credentials are stored locally with restricted permissions | |
| * Authentication required for all file operations | |
| * Deletions require confirmation | |
| * Downloaded files are validated | |
| * Session management is user-controlled | |
| --- | |
| ## 🏁 Stopping Magic Sync | |
| While Magic Sync is running, press: | |
| ``` | |
| Ctrl + C | |
| ``` | |
| to stop it safely. | |
| --- | |
| ## ☁️ Conclusion | |
| pockit CLI is a developer-focused cloud storage tool designed to provide fast, direct file access from the terminal — without relying on a website. | |
| It streamlines workflows, supports real-time synchronization, and delivers a modern CLI experience built for productivity. | |
| --- | |
| **Built for developers. Built for the terminal. ☁️** | |