Installation

Installation Guide

This guide will help you install Transf-ORM-CLI on your system.

System Requirements

Before installing Transf-ORM-CLI, make sure your system meets one of these requirements:

Option A: Using npm (Recommended)

• Node.js 14.0.0 or later
• npm or yarn (comes with Node.js)

Option B: Using Rust/Cargo

• Rust 1.70.0 or later
• Cargo (comes with Rust)

Both options also need:

• Git (for cloning the repository)
• Supported OS: Linux, macOS, Windows

Check Prerequisites

# Check Node.js and npm version (for npm installation)
node --version
npm --version

# Check Rust version (for Cargo installation)
rustc --version
cargo --version

# Check Git version
git --version

If you don't have Node.js installed, visit nodejs.org. If you don't have Rust installed, visit rustup.rs.

Installation Methods

Method 1: From Source (Development)

This is the recommended method if you want the latest features or plan to contribute.

# Clone the repository
git clone https://github.com/Transf-ORM/Transf-ORM-CLI.git
cd Transf-ORM-CLI

# Build the project
cargo build --release

# The binary will be at: ./target/release/transf-orm

Method 2: Using npm (Recommended for most users)

If the package is published to npm:

npm install -g transf-orm-cli

Or using yarn:

yarn global add transf-orm-cli

Method 3: Using Cargo Install

If you prefer using Rust tooling:

cargo install transf-orm-cli

Method 4: Download Pre-built Binaries

Visit the GitHub Releases page and download the binary for your platform.

Verification

After installation, verify it works:

transf-orm --version

# Or if built from source:
./target/release/transf-orm --version

You should see the version number.

Quick Test

# Get help
transf-orm --help

# List available commands
transf-orm help

Adding to PATH (Optional)

Linux/macOS

If you built from source and want to use transf-orm from anywhere:

# Add to PATH (update path if needed)
export PATH="$PATH:$HOME/path/to/Transf-ORM-CLI/target/release"

# Make it permanent (add to ~/.bashrc or ~/.zshrc)
echo 'export PATH="$PATH:$HOME/path/to/Transf-ORM-CLI/target/release"' >> ~/.bashrc

Windows

1. Build the project (see Method 1)
2. Right-click This PC or My Computer → Properties
3. Click Advanced system settings → Environment Variables
4. Under User variables, click New and add:
   • Variable: PATH
   • Value: C:\path\to\Transf-ORM-CLI\target\release

Troubleshooting

"command not found: transf-orm"

The binary is not in your PATH. Either:

• Use the full path: ./target/release/transf-orm
• Add the directory to your PATH (see section above)

"error: linker 'cc' not found"

You need to install a C compiler:

Linux (Debian/Ubuntu):

sudo apt-get install build-essential

Linux (Fedora/RHEL):

sudo dnf install gcc

macOS:

xcode-select --install

"Rust version too old"

Update Rust to the latest stable version:

rustup update stable

Build fails with dependencies error

Make sure you have the latest Cargo dependencies:

cargo update
cargo clean
cargo build --release

Next Steps

After successful installation:

1. Read Quick Start to get started
2. Check Basic Usage for common commands
3. Explore Command Reference for all available commands
4. See Configuration to customize your setup

Getting Help

If you encounter issues during installation:

• Check Troubleshooting
• Open an issue
• Start a discussion
• Contact a maintainer