rakpak 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5bddb74dac931f5f6744b5a1c820c1f5452b3f938e3b3a1e928157926c40ce45
+  data.tar.gz: b4391576a37aa27785f58ddc5ed24237f6f346b67b252d9fb4537f2a1a122406
+SHA512:
+  metadata.gz: 93794a7b3228f6b4064880ebdc637a12194c7eac375e27a5daa3b102dedbdf42fefc998ad9e8854fa22f0393e85c0e590757e1ef8ceb562655920ce4a6a721a6
+  data.tar.gz: '049724035061aa5da75235a1424cbc3927bd24e8738c01c85a4ee60810ffff738f9976a307424086eb41a04f7a804ff1bca0d06f79a73bbd9ae71085f30feabe'

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ryan Wilson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,135 @@
+# rakpak
+
+Tag files and folders anywhere on your filesystem, then archive them all at once.
+
+You walk around, press `space` on anything you want, press `p`, answer a few
+questions, and it builds the archive. The progress view can be sent to the
+background while you keep browsing.
+
+Needs Ruby 3.0 or newer and nothing else.
+
+## Install
+
+```
+gem install rakpak
+```
+
+Then `rakpak` from any folder. If your shell cannot find it afterwards, the
+folder RubyGems puts executables in is not on your PATH; `gem env` shows it
+under EXECUTABLE DIRECTORY.
+
+Without RubyGems, clone this repo and run `./install.sh`. That copies the
+program to `~/.local/share/rakpak` and puts a launcher in `~/.local/bin`,
+adding that folder to your shell startup file if it is not on your PATH yet.
+`./install.sh --link` runs straight from the checkout so edits take effect at
+once, `--prefix /usr/local` installs system-wide, and `--uninstall` removes it.
+
+```
+rakpak                    browse from your home folder
+rakpak ~/Documents        browse from there instead
+rakpak .                  browse from the current folder
+rakpak -p ~/Documents     pack that folder: opens on the archive prompts
+rakpak -p a.txt b/ c      pack several things at once
+```
+
+## Starting up
+
+With no arguments rakpak opens in your home folder: its contents in the
+middle pane, the folder above it on the left, a preview of whatever is under
+the cursor on the right. Give it a folder and it opens there instead.
+
+`-p` (or `--pack`) skips the browsing. Every path you give is tagged, the
+browser opens on the folder holding the first one with the cursor resting on
+it, and the archive prompts appear at once, starting with the kind of archive
+and its compression. The archive is written next to that first path. Press
+`esc` on any prompt and you are back in the browser with the tags still set.
+
+## The flow
+
+1. **Browse and tag.** Vim keys or arrows. `space` tags whatever is under the
+   cursor and moves down. Tags persist as you walk, so you can pick something in
+   `~/Documents`, walk to `/etc`, and tag more. `T` reviews everything tagged.
+   `t` opens a queue pane on the far left that stays up while you browse. It
+   lists each queued item by name, where it lives, and its size, with the
+   running total on top.
+2. **`p` to pack.** Choose *compressed tarball* (the default), *plain
+   tarball*, or *zip archive*.
+3. **Set the flags.** Compression method, level, and the switches for that
+   format. Compressed tarballs default to gzip, the one every system can
+   read.
+4. **Say where.** This directory, your home directory, or one you type
+   into the field right there. `~`, `$HOME` and absolute paths all work,
+   and typing anything jumps to the field.
+5. **Name it.** The extension is added for you.
+6. **Confirm.** You see the exact command before anything runs. Only `enter`
+   starts it.
+7. **Watch it, or press `b`** to drop it into the background and keep browsing.
+
+If nothing is tagged, `p` archives whatever the cursor is on.
+
+## Keys
+
+| | |
+|---|---|
+| `j` `k` `↑` `↓` | move (wraps at either end) |
+| `l` `→` `enter` | enter folder |
+| `h` `←` | leave folder |
+| `gg` `G` | top / bottom |
+| `ctrl-d` `ctrl-u` | half page |
+| `gh` `~` / `gr` | home / root |
+| `space` | tag or untag, then move down |
+| `a` / `d` | tag / untag everything in this folder |
+| `D` | clear all tags |
+| `T` | review tagged items (`space` removes) |
+| `t` | show or hide the queue pane |
+| `/` | filter this folder |
+| `.` | show hidden files |
+| `ctrl-r` | reload |
+| `p` | pack: archive what is tagged |
+| `b` | watch a running job |
+| `?` | all keys |
+| `q` | quit |
+
+In the job view: `b` backgrounds it, `x` cancels, `esc` returns to the
+browser, `q` quits.
+
+## Formats
+
+Every run produces exactly one file.
+
+**Compressed tarball**: `tar` piped through `gzip`, `zstd`, `xz`, `bzip2`,
+`lz4` or `brotli`, giving `.tar.gz`, `.tar.zst` and so on. Each has a level,
+and the tar switches (permissions, xattrs, symlink handling, VCS exclusion,
+reproducible ordering, and so on) are on the same screen.
+
+**Plain tarball**: a bare `.tar`, no compression. Just the tar switches.
+
+**Zip archive**: a `.zip` written by Info-ZIP with deflate, bzip2 or store.
+When exactly one file is selected, the single-file compressors are offered
+here too, so `notes.txt` becomes `notes.txt.gz` or `notes.txt.zst` without a
+tarball around it. For a folder those are greyed out with the reason, since
+`gzip` alone cannot take a folder.
+
+Everything is probed at startup: `PATH` for the compressors, `tar --version` to
+tell GNU tar from bsdtar from busybox, and `zip -v` for its compiled-in methods.
+Anything that will not work on this machine is greyed out with the reason.
+
+## How the archive is shaped
+
+Members are stored relative to the deepest folder that contains every tagged
+path, which is shown on the confirm screen. Tag `~/a/b` and `~/c` and the
+archive holds `a/b` and `c`.
+
+## Notes
+
+- Commands are run directly, not in a shell. Filenames containing spaces,
+  quotes, `$`, `;` or a leading `-` are safe.
+- Cancelling kills the whole process group, so the compressor goes too.
+- Folder sizes are counted in the background. A folder too large to finish
+  counting in a few seconds shows `≥`, meaning the real size is at least that.
+
+## Tests
+
+```
+ruby test/test_rakpak.rb
+```

data/bin/rakpak

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "rakpak"
+
+begin
+  exit Rakpak.start(ARGV)
+rescue Interrupt
+  exit 130
+end