Codex Storage CLI

This CLI is the easiest way to get started with Codex. Get your node up and running in a matter of seconds and start interacting with the Codex Testnet by uploading and downloading files from the other peers in the network.

⚠️ Note : Codex is currently in testnet and there is no guarentee for files stored on the Codex test network. All the files uploaded to Codex are not encrypted by default and hence, the files are publicly accessible. By using this application, you agree to acknowledge the disclaimer.

How it works?

Run the Codex Storage CLI in your terminal

npx codexstorage

Downloading and running the Codex node

A CLI interface would appear with multiple options. Start by downloading the Codex binaries by using option 1.

Once you are done downloading the binaries, you can go ahead and try running the Codex node by choosing option 2. You will be asked to enter your listening (default : 8070) and discovery (default : 8090) ports during this step.

Checking the node status

Now that your node is running, keep the terminal window open and start another instance of the Codex CLI by using the first command. We will be using this terminal to interact with the Codex node that is active.

You can checkout the node status to ensure that the node is discoverable and connected to the other peers in the Codex test network.

If you face any issues (peer discovery, port forwarding etc.,), join our discord server and ask for help.

Uploading and downloading files from the testnet

To upload a new file into the testnet, select option 4 and enter the file's relative path. A unique CID will be displayed once the file is uploaded.

To download a file from the testnet, select option 5 and enter the file's CID.

If you wish to view all the files that are stored in your local node, choose option 6 to display all the available CIDs.

What's next?

More features will be added soon!