Spaces:
Running
Running
Update README.md
Browse files
README.md
CHANGED
|
@@ -6,5 +6,224 @@ colorTo: green
|
|
| 6 |
sdk: static
|
| 7 |
pinned: false
|
| 8 |
---
|
|
|
|
| 9 |
|
| 10 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 6 |
sdk: static
|
| 7 |
pinned: false
|
| 8 |
---
|
| 9 |
+
# βοΈ pockit CLI
|
| 10 |
|
| 11 |
+
<p align="center">
|
| 12 |
+
<img src="scr.png" width="650" alt="pockit CLI Screenshot" />
|
| 13 |
+
</p>
|
| 14 |
+
|
| 15 |
+
## π Welcome to pockit
|
| 16 |
+
|
| 17 |
+
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.
|
| 18 |
+
|
| 19 |
+
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.
|
| 20 |
+
|
| 21 |
+
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.
|
| 22 |
+
|
| 23 |
+
This tool is designed for developers, power users, and anyone who wants efficient cloud access without opening a browser.
|
| 24 |
+
|
| 25 |
+
---
|
| 26 |
+
|
| 27 |
+
## π― Purpose of pockit
|
| 28 |
+
|
| 29 |
+
pockit exists to:
|
| 30 |
+
|
| 31 |
+
* Provide direct cloud file access from the terminal
|
| 32 |
+
* Offer an alternative to using the web interface
|
| 33 |
+
* Speed up developer workflows
|
| 34 |
+
* Enable automation and scripting
|
| 35 |
+
* Deliver a clean, interactive CLI experience
|
| 36 |
+
* Support real-time folder synchronization
|
| 37 |
+
|
| 38 |
+
It is built to integrate naturally into development environments, CI workflows, and everyday terminal usage.
|
| 39 |
+
|
| 40 |
+
---
|
| 41 |
+
|
| 42 |
+
## β¨ Key Features
|
| 43 |
+
|
| 44 |
+
pockit combines powerful functionality with a polished interface.
|
| 45 |
+
|
| 46 |
+
### π Secure Session Handling
|
| 47 |
+
|
| 48 |
+
* Interactive login system
|
| 49 |
+
* Local session caching for convenience
|
| 50 |
+
* Automatic reuse of saved sessions
|
| 51 |
+
* Secure storage of credentials
|
| 52 |
+
* Manual logout support
|
| 53 |
+
|
| 54 |
+
### π Full File Management
|
| 55 |
+
|
| 56 |
+
* List all files
|
| 57 |
+
* Upload local files
|
| 58 |
+
* Download files interactively
|
| 59 |
+
* Delete files safely with confirmation
|
| 60 |
+
* Change account password
|
| 61 |
+
|
| 62 |
+
### β¨ Magic Sync Mode
|
| 63 |
+
|
| 64 |
+
* Continuous two-way synchronization
|
| 65 |
+
* Detects new, modified, and removed files
|
| 66 |
+
* Keeps a local folder and cloud storage identical
|
| 67 |
+
* Runs until manually stopped
|
| 68 |
+
* Cross-platform support
|
| 69 |
+
|
| 70 |
+
### π¨ Modern Terminal Experience
|
| 71 |
+
|
| 72 |
+
* Styled output using Rich
|
| 73 |
+
* Interactive prompts
|
| 74 |
+
* Spinners and progress bars
|
| 75 |
+
* Clean tables and panels
|
| 76 |
+
* Color-coded status messages
|
| 77 |
+
|
| 78 |
+
---
|
| 79 |
+
|
| 80 |
+
## π₯οΈ Commands
|
| 81 |
+
|
| 82 |
+
### `pockit login`
|
| 83 |
+
|
| 84 |
+
Start a secure session.
|
| 85 |
+
|
| 86 |
+
### `pockit logout`
|
| 87 |
+
|
| 88 |
+
Clear saved session data.
|
| 89 |
+
|
| 90 |
+
### `pockit ls`
|
| 91 |
+
|
| 92 |
+
List all files in your cloud storage.
|
| 93 |
+
|
| 94 |
+
### `pockit upload`
|
| 95 |
+
|
| 96 |
+
Upload a local file to the cloud.
|
| 97 |
+
|
| 98 |
+
* Interactive file selection
|
| 99 |
+
* Optional rename
|
| 100 |
+
* Progress feedback
|
| 101 |
+
|
| 102 |
+
### `pockit download`
|
| 103 |
+
|
| 104 |
+
Download a selected cloud file.
|
| 105 |
+
|
| 106 |
+
* Interactive selection
|
| 107 |
+
* Choose save location
|
| 108 |
+
* Validated before saving
|
| 109 |
+
|
| 110 |
+
### `pockit delete`
|
| 111 |
+
|
| 112 |
+
Remove a file from cloud storage.
|
| 113 |
+
|
| 114 |
+
* Requires confirmation
|
| 115 |
+
* Prevents accidental deletion
|
| 116 |
+
|
| 117 |
+
### `pockit chpasswd`
|
| 118 |
+
|
| 119 |
+
Change your account password securely.
|
| 120 |
+
|
| 121 |
+
### `pockit magicsync`
|
| 122 |
+
|
| 123 |
+
Enable continuous synchronization between a local folder and your cloud storage.
|
| 124 |
+
|
| 125 |
+
* Automatic updates both ways
|
| 126 |
+
* Detects changes using file hashing
|
| 127 |
+
* Stop anytime with `Ctrl + C`
|
| 128 |
+
|
| 129 |
+
---
|
| 130 |
+
|
| 131 |
+
## π Magic Sync Folder
|
| 132 |
+
|
| 133 |
+
Magic Sync uses a dedicated folder depending on your operating system:
|
| 134 |
+
|
| 135 |
+
* **macOS & Windows:** Desktop β `Pockit-magicSync`
|
| 136 |
+
* **Linux:** Uses system desktop directory if available, otherwise creates a folder in your home directory.
|
| 137 |
+
|
| 138 |
+
This ensures a consistent sync location across platforms.
|
| 139 |
+
|
| 140 |
+
---
|
| 141 |
+
|
| 142 |
+
## π How Magic Sync Works
|
| 143 |
+
|
| 144 |
+
Magic Sync continuously monitors both local and cloud files.
|
| 145 |
+
|
| 146 |
+
It automatically:
|
| 147 |
+
|
| 148 |
+
* Detects new files
|
| 149 |
+
* Detects modified files
|
| 150 |
+
* Detects deleted files
|
| 151 |
+
* Applies updates in both directions
|
| 152 |
+
* Keeps environments perfectly aligned
|
| 153 |
+
|
| 154 |
+
This enables seamless development workflows and instant synchronization.
|
| 155 |
+
|
| 156 |
+
---
|
| 157 |
+
|
| 158 |
+
## ποΈ Design Philosophy
|
| 159 |
+
|
| 160 |
+
pockit is built with:
|
| 161 |
+
|
| 162 |
+
* Developer-first thinking
|
| 163 |
+
* Clean command structure
|
| 164 |
+
* Cross-platform compatibility
|
| 165 |
+
* Automation-friendly workflows
|
| 166 |
+
* Interactive usability
|
| 167 |
+
* Lightweight performance
|
| 168 |
+
|
| 169 |
+
The goal is to make cloud file management fast, intuitive, and terminal-native.
|
| 170 |
+
|
| 171 |
+
---
|
| 172 |
+
|
| 173 |
+
## π Installation
|
| 174 |
+
|
| 175 |
+
pockit is available on **PyPI** and can be installed directly with:
|
| 176 |
+
|
| 177 |
+
```bash
|
| 178 |
+
pip install pockit
|
| 179 |
+
```
|
| 180 |
+
|
| 181 |
+
After installation, run it using:
|
| 182 |
+
|
| 183 |
+
```bash
|
| 184 |
+
pockit <command>
|
| 185 |
+
```
|
| 186 |
+
|
| 187 |
+
Example workflow:
|
| 188 |
+
|
| 189 |
+
```bash
|
| 190 |
+
pockit login
|
| 191 |
+
pockit upload
|
| 192 |
+
pockit ls
|
| 193 |
+
pockit download
|
| 194 |
+
pockit magicsync
|
| 195 |
+
```
|
| 196 |
+
|
| 197 |
+
---
|
| 198 |
+
|
| 199 |
+
## π Security Overview
|
| 200 |
+
|
| 201 |
+
* Credentials are stored locally with restricted permissions
|
| 202 |
+
* Authentication required for all file operations
|
| 203 |
+
* Deletions require confirmation
|
| 204 |
+
* Downloaded files are validated
|
| 205 |
+
* Session management is user-controlled
|
| 206 |
+
|
| 207 |
+
---
|
| 208 |
+
|
| 209 |
+
## π Stopping Magic Sync
|
| 210 |
+
|
| 211 |
+
While Magic Sync is running, press:
|
| 212 |
+
|
| 213 |
+
```
|
| 214 |
+
Ctrl + C
|
| 215 |
+
```
|
| 216 |
+
|
| 217 |
+
to stop it safely.
|
| 218 |
+
|
| 219 |
+
---
|
| 220 |
+
|
| 221 |
+
## βοΈ Conclusion
|
| 222 |
+
|
| 223 |
+
pockit CLI is a developer-focused cloud storage tool designed to provide fast, direct file access from the terminal β without relying on a website.
|
| 224 |
+
|
| 225 |
+
It streamlines workflows, supports real-time synchronization, and delivers a modern CLI experience built for productivity.
|
| 226 |
+
|
| 227 |
+
---
|
| 228 |
+
|
| 229 |
+
**Built for developers. Built for the terminal. βοΈ**
|