cli/README.md

77 lines
1.1 KiB
Markdown
Raw Normal View History

2024-10-31 02:19:42 +00:00
# Codex Storage CLI
A command-line interface for interacting with Codex Storage.
2024-10-31 02:19:42 +00:00
## Features
2024-10-31 02:19:42 +00:00
- Install and manage Codex node
- Run Codex node with custom configuration
- Check node status and connected peers
- Upload and download files
- View local data
- Cross-platform support (Windows, Linux, macOS)
2024-10-31 02:19:42 +00:00
## Installation
2024-10-31 02:19:42 +00:00
```bash
npm install -g codexstorage
2024-10-31 02:19:42 +00:00
```
Or run directly with npx:
2024-10-31 02:19:42 +00:00
```bash
npx codexstorage
```
2024-10-31 02:19:42 +00:00
## Usage
2024-10-31 02:19:42 +00:00
### Interactive Mode
2024-10-31 02:19:42 +00:00
Simply run:
2024-10-31 02:19:42 +00:00
```bash
codexstorage
```
2024-10-31 02:19:42 +00:00
This will start the interactive CLI menu where you can:
1. Download and install Codex
2. Run Codex node
3. Check node status
4. Upload a file
5. Download a file
6. Show local data
7. Uninstall Codex node
2024-10-31 02:19:42 +00:00
### Command Line Mode
2024-10-31 02:19:42 +00:00
Upload a file:
```bash
codexstorage --upload <filename>
```
2024-10-31 02:19:42 +00:00
Download a file:
```bash
codexstorage --download <cid>
```
2024-10-31 02:19:42 +00:00
## Requirements
2024-10-31 02:19:42 +00:00
- Node.js 14 or higher
- For Linux users: libgomp1 library
- For Windows users: curl command available
2024-10-31 02:19:42 +00:00
## Development
2024-10-31 02:19:42 +00:00
1. Clone the repository
2. Install dependencies:
```bash
npm install
```
3. Run the CLI:
```bash
npm start
```
2024-10-31 02:19:42 +00:00
## License
2024-10-31 02:19:42 +00:00
MIT