|
1 | | -# web3data-cli |
| 1 | +# 🌐 Web3 Data CLI |
| 2 | + |
| 3 | +A simple, secure, and extensible command-line tool written in Go for managing Web3-related data. |
| 4 | + |
| 5 | +**Web3 Data CLI** (`web3datacli`) helps you handle sensitive data through strong AES encryption and enables seamless file sharing via IPFS. |
| 6 | + |
| 7 | +--- |
| 8 | + |
| 9 | +## ✨ Features |
| 10 | + |
| 11 | +- 🔐 AES encryption & decryption (256-bit) |
| 12 | +- 🗂 Local key generation and management |
| 13 | +- 📤 File uploads and download to IPFS |
| 14 | +- 🧩 Built with extensibility in mind — easy to plug in more Web3 features |
| 15 | +- 💻 Native binaries for Linux and macOS |
| 16 | + |
| 17 | +--- |
| 18 | + |
| 19 | +## 📦 Installation |
| 20 | + |
| 21 | +Download the latest binary from the [Releases](https://github.com/your-org/web3datacli/releases) page. |
| 22 | + |
| 23 | +### Linux |
| 24 | + |
| 25 | +```bash |
| 26 | +wget https://github.com/your-org/web3datacli/releases/latest/download/web3datacli-linux -O web3datacli |
| 27 | +chmod +x web3datacli |
| 28 | +sudo mv web3datacli /usr/local/bin/web3datacli |
| 29 | +``` |
| 30 | + |
| 31 | +### macOS |
| 32 | + |
| 33 | +```bash |
| 34 | +wget https://github.com/your-org/web3datacli/releases/latest/download/web3datacli-darwin -O web3datacli |
| 35 | +chmod +x web3datacli |
| 36 | +sudo mv web3datacli /usr/local/bin/web3datacli |
| 37 | +``` |
| 38 | + |
| 39 | +--- |
| 40 | + |
| 41 | +## 🚀 Usage |
| 42 | + |
| 43 | +```bash |
| 44 | +web3datacli [command] |
| 45 | +``` |
| 46 | + |
| 47 | +### Available Commands |
| 48 | + |
| 49 | +| Command | Description | |
| 50 | +|--------------|----------------------------------------| |
| 51 | +| `encryption` | 🔐 Manage data encryption and decryption | |
| 52 | +| `ipfs` | 📤 Interact with IPFS | |
| 53 | +| `version` | Show the CLI version | |
| 54 | +| `completion` | Generate autocompletion for your shell | |
| 55 | +| `help` | Help about any command | |
| 56 | + |
| 57 | +--- |
| 58 | + |
| 59 | +## 🧠 Autocompletion |
| 60 | + |
| 61 | +Enable autocompletion for your shell (e.g., bash, zsh): |
| 62 | + |
| 63 | +```bash |
| 64 | +web3datacli completion bash > /etc/bash_completion.d/web3datacli |
| 65 | +source /etc/bash_completion.d/web3datacli |
| 66 | +``` |
| 67 | + |
| 68 | +--- |
| 69 | + |
| 70 | +## 🧾 License |
| 71 | + |
| 72 | +MIT License © 2025 F.CORDIER |
| 73 | + |
| 74 | +--- |
| 75 | + |
| 76 | +## 🤝 Contributions |
| 77 | + |
| 78 | +Feel free to open issues or submit PRs — contributions are welcome! |
0 commit comments