Before you begin, ensure you have Node.js version 14 or higher (version 18 is recommended) installed on your machine. The Codex CLI requires Node.js to run.
Installation Steps
Open your terminal
Run the following command:
npx codexstorage
Select option 1: "Download and install Codex" from the menu
Follow the prompts to complete the installation
{/* Step 3: Run Your Node */}
3
Run Your Node
Start your Codex node and verify its status
Required
Starting Your Node
Select option 2: "Run Codex node" from the main menu
Press Enter to use default ports (or enter custom ports if needed)
Keep this terminal window open to keep your node running
Keep Terminal Active
The node stops running once you close this terminal. Keep it open to maintain node operation.
Verify Node Status
Open a new terminal window
Run npx codexstorage again
Select option 3: "Check node status"
Choose "View Node Information" to see your unique Node ID
Important
Make sure to save your Node ID as you'll need it for the verification step.
{/* Step 4: Test Your Node */}
4
Test Your Node
Upload and download files to test your setup
Optional
Upload a File
You can upload a file using either of these methods:
Select option 4: "Upload a file" from the main menu
Or use the command:
npx codexstorage --upload <PATH-TO-THE-FILE>
Download a File
To download a file from the network:
Select option 5: "Download a file" from the main menu
Or use the command:
npx codexstorage --download <CID>
File Persistence
Testnet files are not persistent and are cleared within 48 hours.