Skip to content

CLI application to set up a Codex node and interact with the test network

Notifications You must be signed in to change notification settings

codex-storage/cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Codex Storage CLI

A command-line interface for interacting with Codex Storage.

Features

  • 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)

Installation

npm install -g codexstorage

Or run directly with npx:

npx codexstorage

Usage

Interactive Mode

Simply run:

codexstorage

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

Command Line Mode

Upload a file:

codexstorage --upload <filename>

Download a file:

codexstorage --download <cid>

Requirements

  • Node.js 14 or higher
  • For Linux users: libgomp1 library
  • For Windows users: curl command available

Development

  1. Clone the repository
  2. Install dependencies:
npm install
  1. Run the CLI:
npm start

License

MIT

About

CLI application to set up a Codex node and interact with the test network

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published