Skip to main content

​
Prerequisites

Before installing Cubipods, ensure you have:
  • Rust (version 1.56 or later)
  • Cargo (Rust’s package manager, included with Rust)
If you don’t have Rust installed, visit rustup.rs to install it.

​
Installation Steps

1

Install Cubipods via Cargo

Run the following command to install Cubipods from crates.io:
cargo install cubipods
This will download, compile, and install the cubipods binary to your Cargo bin directory (typically ~/.cargo/bin/).
The installation may take a few minutes as Cargo compiles the project and its dependencies.
2

Verify Installation

Confirm that Cubipods is installed correctly by checking the version:
cubipods --version
You should see output similar to:
cubipods 0.1.1
3

Test Basic Functionality

Run a simple test to ensure everything is working:
cubipods --bytecode 6001
This executes the PUSH1 0x01 opcode. If successful, Cubipods will execute without errors.
Without verbose mode, Cubipods executes silently. To see execution details, add the -v flag (covered in the Quickstart).

​
Installation Troubleshooting

If you get a “command not found” error, ensure that ~/.cargo/bin is in your system’s PATH:
# Add to ~/.bashrc or ~/.zshrc
export PATH="$HOME/.cargo/bin:$PATH"
Then reload your shell configuration:
source ~/.bashrc  # or source ~/.zshrc
If you encounter compilation errors during installation:
  1. Update Rust to the latest stable version: 
    rustup update stable
  2. Try the installation again: 
    cargo install cubipods
If you encounter permission errors:
  • Ensure you have write permissions to the Cargo bin directory
  • Avoid using sudo with Cargo commands, as this can cause permission issues
  • Check that your Rust installation is user-local (not system-wide)

​
Dependencies

Cubipods automatically installs the following dependencies:
  • clap (v4.5.16) - Command-line argument parsing
  • tiny-keccak (v2.0.2) - Cryptographic hashing for the KECCAK256 opcode
  • hex (v0.4.3) - Hexadecimal encoding and decoding
All dependencies are managed automatically by Cargo during installation.

​
Building from Source

If you prefer to build from source:
1

Clone the repository

git clone https://github.com/icanvardar/cubipods.git
cd cubipods
2

Build the project

cargo build --release
3

Run the binary

./target/release/cubipods --bytecode 6001

​
Next Steps

Quickstart

Learn how to execute your first bytecode and explore Cubipods features

Build docs developers (and LLMs) love

Get started for freeTalk to us