Dosu Logo
Home
Documents
installation
installation
Type
External
Status
Published
Created
Mar 7, 2026
Updated
Mar 7, 2026

Installation#

Stringy is currently in active development and not yet published to crates.io. You can install it from source or use development builds.

Prerequisites#

  • Rust: Version 1.70 or later
  • Git: For cloning the repository
  • Build tools: Platform-specific C compiler (for some dependencies)

Installing Rust#

If you don't have Rust installed, get it from rustup.rs:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
source ~/.cargo/env

Clone and Build#

git clone https://github.com/EvilBit-Labs/StringyMcStringFace
cd StringyMcStringFace
cargo build --release

Install Locally#

cargo install --path .

This installs the stringy binary to ~/.cargo/bin/, which should be in your PATH.

Verify Installation#

stringy --help

Development Build#

For development and testing:

git clone https://github.com/EvilBit-Labs/StringyMcStringFace
cd StringyMcStringFace
cargo run -- --help

Platform-Specific Notes#

Linux#

Most distributions include the necessary build tools. If you encounter issues:

# Ubuntu/Debian
sudo apt update
sudo apt install build-essential

# Fedora/RHEL
sudo dnf groupinstall "Development Tools"

# Arch Linux
sudo pacman -S base-devel

macOS#

Install Xcode command line tools:

xcode-select --install

Windows#

Install Visual Studio Build Tools or Visual Studio Community with C++ support.

Alternatively, use the GNU toolchain:

rustup toolchain install stable-x86_64-pc-windows-gnu
rustup default stable-x86_64-pc-windows-gnu

Docker (Alternative)#

If you prefer containerized builds:

FROM rust:1.70 as builder
WORKDIR /app
COPY . .
RUN cargo build --release

FROM debian:bookworm-slim
RUN apt-get update && apt-get install -y ca-certificates && rm -rf /var/lib/apt/lists/*
COPY --from=builder /app/target/release/stringy /usr/local/bin/
ENTRYPOINT ["stringy"]

Build and run:

docker build -t stringy .
docker run --rm -v $(pwd):/data stringy /data/binary_file

Troubleshooting#

Common Issues#

"cargo: command not found"#

Ensure Rust is properly installed and ~/.cargo/bin is in your PATH:

echo 'export PATH="$HOME/.cargo/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc

Build Failures#

Update Rust to the latest version:

rustup update

Clear the build cache:

cargo clean
cargo build --release

Permission Denied#

On Unix systems, ensure the binary is executable:

chmod +x ~/.cargo/bin/stringy

Getting Help#

If you encounter issues:

  1. Check the troubleshooting guide
  2. Search existing GitHub issues
  3. Open a new issue with:
    • Your operating system and version
    • Rust version (rustc --version)
    • Complete error output
    • Steps to reproduce

Next Steps#

Once installed, see the Quick Start guide to begin using Stringy.