Skip to content

BlackTechX011/BTXS

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

██████╗ ████████╗██╗  ██╗███████╗
██╔══██╗╚══██╔══╝╚██╗██╔╝██╔════╝
██████╔╝   ██║    ╚███╔╝ ███████╗
██╔══██╗   ██║    ██╔██╗ ╚════██║
██████╔╝   ██║   ██╔╝ ██╗███████║
╚═════╝    ╚═╝   ╚═╝  ╚═╝╚══════╝
  

BTXS™ File Splitter

A modern, reliable, high-performance command-line file splitter and merger.

Latest Release License Build Status

InstallationQuick StartCommandsContributingLicense


BTXS™ is a professional command-line tool for splitting large files into smaller, more manageable chunks and merging them back together. It's built from the ground up to be reliable and provide a polished user experience, ensuring your data is never corrupted during the process.

Note

BTXS™ embeds a unique header in every chunk. This allows the merge command to automatically find and assemble the correct pieces, even if chunks from multiple different files are in the same directory.

🚀 Installation

The recommended way to install BTXS™ is with our one-line installer. It automatically detects your OS and architecture, downloads the correct binary from the latest release, and adds it to your system's PATH.

Important

The scripts below are the only official installation methods. Always download from the official BlackTechX011/BTXS repository to ensure you are getting a secure and untampered version of the tool.


Linux / macOS / Termux

This command works on most Unix-like systems, including Debian/Ubuntu, Fedora, Arch, macOS (Intel & Apple Silicon), and Termux on Android.

curl -fsSL https://raw.githubusercontent.com/BlackTechX011/BTXS/main/scripts/install.sh | sh

Tip

After installation, you may need to restart your terminal or run source ~/.zshrc, source ~/.bashrc, etc., to refresh your PATH environment variable.


Windows (PowerShell)

Note

This command temporarily adjusts the execution policy only for the current process. It's a safe and standard way to run trusted remote scripts and does not permanently change your system's security settings.

Open a new PowerShell (as a regular user) and run:

Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass; iwr https://raw.githubusercontent.com/BlackTechX011/BTXS/main/scripts/install.ps1 | iex

Warning

You must open a new PowerShell window after the installation completes. The PATH environment variable is only loaded when a new terminal session starts.

Manual Installation
  1. Go to the Releases page.
  2. Download the appropriate binary for your operating system and architecture (e.g., btxs-windows-amd64.exe).
  3. Rename the binary to btxs (or btxs.exe on Windows).
  4. Move the binary to a directory included in your system's PATH (e.g., /usr/local/bin on Linux/macOS, or a custom folder on Windows that you add to the Path Environment Variable).
  5. On Linux/macOS, make the binary executable: chmod +x /usr/local/bin/btxs.

⚡ Quick Start

Using BTXS™ is designed to be intuitive. Here are the most common operations.

1. Split a File

To split a large file into smaller .btxs chunks:

# Split a large backup file into 50MB chunks
btxs split --in database_backup.sql --out ./backup_parts --size 50MB

This will create files like database_backup.0001.btxs, database_backup.0002.btxs, etc.

Tip

Use the -n or --name flag to give your chunks a custom name: btxs split ... --name "project-alpha-backup"

2. Merge Chunks

To reassemble the original file from a directory of chunks:

# BTXS will automatically find all related .btxs files and merge them
btxs merge --dir ./backup_parts

The merged file will be saved in the parent directory as merged_database_backup.sql.

📖 Command Reference

Click to expand the full command reference
Command Alias Description Options
split s Splits a file into smaller, encrypted chunks. --in <path> (Required)
--out <dir>
--size <size>
--name <name>
merge m Merges .btxs chunks back into the original file. --dir <dir>
help h Displays help information for a command.

🗺️ Project Roadmap

This project is actively developed. Here is a list of planned features. Contributions are welcome!

Core Features

  • Core split and merge commands
  • Data integrity verification via SHA-256
  • Smart chunk detection and assembly
  • Custom chunk naming
  • Add support for different encryption ciphers (--cipher)
  • Implement a test command to verify chunk integrity without merging
  • Implement a repair command for partially damaged sets (if possible)

User Experience

  • Professional CLI with help and versioning
  • Cross-platform build and release workflow
  • Implement self-update mechanism (btxs update)
  • Add detailed progress bars for large file operations
  • Add a global configuration file (~/.config/btxs/config.toml)

Documentation & Community

  • LICENSE.md with custom EULA
  • CONTRIBUTING.md and Issue Templates
  • Create a GitHub Pages site for full documentation

Have an idea or found a bug? Open an issue! We'd love to hear from you.

🤝 Contributing

Contributions are the backbone of open source. We welcome contributions of all kinds, from filing detailed bug reports to implementing new features.

Before you start, please take a moment to read our guidelines:

  • Contribution Guide: The main guide for how to submit pull requests, our coding standards, and the development process.
  • Open an Issue: The best place to report a bug, ask a question, or propose a new feature.

🛡️ Security Model

Caution

This software is provided "as is" without warranty of any kind. While the lightweight encryption provides obfuscation, it is not a substitute for enterprise-grade cryptographic standards. For highly sensitive data, encrypt the file before splitting it.

The security of BTXS™ is a top priority. If you discover a security vulnerability, we ask that you report it to us privately to protect our users.

Please do not open a public GitHub issue for security-related concerns.

Instead, send a detailed report directly to: BlackTechX@proton.me

We will make every effort to respond to your report in a timely manner.

⚖️ License

This software is distributed under a custom End-User License Agreement (EULA).

Important

The license grants permission for personal, non-commercial use only. For any other use, including commercial, corporate, or government, please contact the author.

Please see the LICENSE.md file for the full terms and conditions.


BTXS™ is a trademark of BlackTechX011. All rights reserved.

(back to top)