Skip to content

Latest commit

 

History

3 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 

Repository files navigation

x4m - X4 Manager

x4m is a high-performance, cross-platform CLI tool designed for managing files on an Xteink X4 ereader device running Crosspoint community firmware. Optimized for speed and reliability, it supports recursive directory management, smart synchronization and automated wallpaper shuffling.

I wrote this primarily to upload/sync my Calibre managed epub library hence only working with epub files (or xtc) rather than just shoveling everything/incompatible files onto the device. The wallpaper addition was an afterthought just to make use of my own API at x4ePapers

Features

  • Smart Uploads: Only uploads files that don't already exist on the device. (target directory)
  • Sync: Mirror local directories to the device and automatically remove orphaned files.
  • Recursive Operations: Deep-listing and recursive deletion support.
  • Format Validation: Native support for .epub and optional .xtc file handling.
  • Cross-Platform: Compiled for macOS (Intel/M1,2), Linux (amd64/ARM), and Windows.
  • Simple UI: Clean, ASCII-based status logging for best terminal readability.
  • Wallpapers: Integrated with the x4epapers API to fetch and set random wallpapers for single or shuffle modes.

Installation

Download the appropriate binary for your system from the releases page:

# Example for Linux
chmod +x x4m_v0.9.0-stable_linux_amd64
sudo mv x4m_v0.9.0-stable_linux_amd64 /usr/local/bin/x4m

Ready Device

Make sure your device is running the Crosspoint firmware (tested with version 0.16.0)

  • Boot device >> File Transfer >> Join A Network >> {Your_Network} >> Run x4m -list /

Usage Examples

Uploading & Syncing: Keep your library in sync without re-uploading existing files.

# Upload a folder to a specific destination
x4m -upload "./MyBooks" -dest "/Library"

# Sync a folder (this will prompt to delete files on the device that aren't in your local folder)
x4m -upload "./MyBooks" -dest "/Library" -sync

# Include .xtc files in your upload
x4m -upload "./MyBooks" -dest "/Library" -xtc

# Running without -dest will create and upload your source directory to the device as is.

File Management: Explore or clean up your device storage.

# List the root directory
x4m -list /

# Recursive list of the entire device
x4m -list / -r

# Delete a specific book or folder (Root deletion is blocked for safety)
x4m -del "/Library/Obsolete_Book.epub"

# -del / -list also support all directories.

Wallpaper Management: Fetch wallpapers directly from the x4epapers.lowio.xyz API.

# Set a single main sleep screen
x4m -wallpaper single

# Fill /sleep/ with 10 random images for the shuffle feature
x4m -wallpaper shuffle

About

A high-performance, cross-platform CLI tool designed for managing files on the Xteink X4 ereader device running the Crosspoint community firmware.

Resources

Stars

16 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages