Skip to content

Latest commit

 

History

History
157 lines (129 loc) · 10.9 KB

README.md

File metadata and controls

157 lines (129 loc) · 10.9 KB

Logistics

Logistics brings file browsing, media tools and remote-folder management into one desktop app. Browse your files, see what's taking up space, read comics, rename batches of files, or work with your servers and libraries.

It runs on Windows, macOS and Linux. Some tools are specific to one platform or need another application installed.

Mobile Settings includes bundled offline documentation with nested folder browsing and file/title or page-text search.

Get started

  1. Download release.zip from GitHub Releases when a packaged release is available. Choose that file rather than GitHub's automatic “Source code” ZIP: it includes the shared commonUtils files too.

  2. Extract the ZIP and open the Logistics folder.

  3. Start the app using the launcher for your computer:

    Computer What to open
    Windows Double-click LaunchLogistics_WIN.bat
    macOS Double-click LaunchLogistics_MAC.command
    Linux Open a terminal in the folder and run bash LaunchLogistics_LINUX_UV.sh

The launcher sets up Python and the required Python packages for you. You'll need an internet connection for the first run. Setup may take a little while; later launches reuse the installed environment.

The Qt 6.12 interface requires macOS 14 or newer, Windows 10/11, or Linux with glibc 2.34 or newer on x86-64 (2.39 or newer on ARM64).

Using Git instead? Clone with the shared utilities included, then open the same launcher:

git clone --recurse-submodules https://github.com/ispaure/logistics.git

If you've already cloned it, run git submodule update --init --recursive in the project folder to fetch any missing shared files.

You can open several Logistics instances. They share indexing work and progress; another open instance can resume unfinished indexing if its owner closes. If all instances close, queued indexing resumes on the next launch.

Appearance and systemic tool settings share one Logistics Settings window, with repository defaults, personal AppData overrides and per-field reset. Fonts cover the interface, browser, reading and code; accent colors also tint dark surfaces.

Find your way around

The launch page offers Open full hub with sidebar, or File Browser, Git and IDE without the sidebar. Read & edit cards launch enabled editors and readers, including comics, EPUBs and archives. Single-tool views keep a small settings icon at the bottom-left; clicking it opens settings and navigation choices.

Use File Browser for any folder, or Folder Hub for configured libraries and remote storage. Documents collects open readers and editors; their tabs can be split or detached. Text, Markdown, EPUB and comic Open dialogs share a Local/LocalCrypt file picker; encrypted copies open in private readers or editors. Regular and private file browsers share list, tile and column views. Settings saves feature choices and configuration and provides links to each feature's help.

Start with files and documents, then choose a guide below. The configuration guide explains resource paths, credentials and settings. External services need their own accounts/software.

What can it do?

An independent Android/iOS document prototype is available for development builds, with a native hub, private preferences, text editing and single-pane formatted/Source Markdown editing (preview by default), EPUB/comic reading, LM text chat, managed rclone Local/LocalCrypt copies and encrypted LocalCrypt offline reading, side-by-side saved and session-only credential packages, text and comic/EPUB metadata editing, local file/folder management with shared list/tile views, thumbnails and file information, and text Save As across Local/LocalCrypt storage. Encrypted transfers and archive metadata updates and ordinary comic imports stream large files without a fixed whole-file size cap. Standalone AES/legacy password-protected CBZ/ZIP comics open with an inline password prompt and can be locked after reading. Shared mobile browsing includes folder taps, Back history and search/sort. See its guide for format limits and validation status. Native readers include EPUB passage resume/search, comic spreads and imported-copy metadata editing, including explicit-field comic batches. Mobile Pull and reviewed Push show progress while ordinary documents remain usable. Mobile can save multiple SMB/Mac server connections and pull shared folders into device storage. Android can keep Local and LocalCrypt together on a selected SD card under Logistics/Local and Logistics/LocalCrypt. On iPhone/iPad, Local uses the Finder/iTunes and Files app sharing root, with automatic migration and exclusion from device backups; LocalCrypt remains private. Mobile includes a Focus home screen, file/conversation drawers and equal-width browser/document or two-text-document panes in wide windows. Chat and Settings use full-screen destinations. Independent ordinary iPad windows have separate workspaces and prevent duplicate writers. Crypt files offer both encrypted offline copies and direct remote previews. A Mac can build, install and launch the iPhone app over Wi-Fi using the paired-device workflow. A double-click Android launcher stages local sources, builds and installs on a connected Android device. A Firebase beta launcher builds and signs Android APKs for invited testers; a combined launcher runs device installs and both beta distributions. An opt-in TestFlight workflow prepares archives and uploads with the same app identity after developer enrollment approval. For first-time Xcode setup, local builds, TestFlight and Android instructions, start with the mobile build and release handbook.

Tool Use it to…
File Browser & Markdown Browse files, explore storage usage, and open Markdown Notes Libraries from location actions
Git Clone repositories, browse history, stage and commit changes, manage branches and remotes
Bulk Rename Preview and apply changes to many filenames at once
Text Editor Edit text and code in tabs, search/replace, see Git change markers, and preserve file encodings
IDE Keep dockable projects, arrange shared file views in up to three internal groups, navigate Python definitions, search project files, and autosave with Git change markers
LM Chat Chat with an existing LM server, paste screenshots, discuss IDE projects with read-only file tools, and save conversations locally
Books and Comics Read EPUBs and CBZs, edit metadata, and manage comic collections
PDF Reader Read and search local, remote and LocalCrypt PDFs on desktop and mobile, jump to page numbers, and swipe vertically
Archives Browse, create, encrypt, test and extract ZIP/TAR archives
Images Compress images and work with photo metadata
rclone Browse remotes in read-only tabs, open supported files in memory, and use managed Pull/Push for local or encrypted folders
FUSE Open supported remote storage as a mounted folder
Calibre Open book libraries and export books
Plex Back up and restore media-server data
YouTube Downloader Download channels and playlists
Minecraft Find and manage local servers
Blender Launch Blender configuration cards; manage presets, compatible addon libraries and Blue Hole branches/Deluxe in Settings
Perforce Launch configured servers on Linux
Obsidian Find and open vaults
Dropbox Browse Dropbox folders and clean up conflicting copies
Links Keep useful website shortcuts together
Smart Home Control Philips Hue and access Tautulli tools
Aviation Tools Flight calculators and aircraft/airport reference data
Flight Simulator Manage X-Plane settings and window presets
Media Rename audio chapters from a CSV
File Tools Check filenames and remove Python bytecode files
System Tools Run platform-specific maintenance tools

Additional emulator tools are available on request through ispaure’s ally-tools.

Learn more

Start at the documentation wiki for the user, mobile user and development hierarchies. Feature manuals live in each owner’s docs/ folder.

For contributions, use the development and validation guide. Feature changes should include updates to their user guides. The application uses Python 3.12.2 and pinned dependencies; normal launchers manage that environment. Git and optional external tools are installed/configured separately.

License

Logistics is available under the MIT License.

Logistics can update itself from published main, beta or alpha releases through Update Logistics in the hub. Checks are on by default; choose a channel or turn them off in Settings → Configuration → Updates. Updates preserve private software, credentials and ignored files. See release packaging for supported installation manifests and channel tags.