CLI reference¶

The CLI is intentionally clean and minimal. Most behavior is encoded in the workflow with sensible defaults.

Synopsis¶

revdeprun [OPTIONS] <REPOSITORY>
revdeprun bundle [OPTIONS] [PACKAGE_DIR]

The first form runs the end-to-end check. The bundle subcommand packs the results of a finished check for transfer; see Bundle below.

Options¶

Name	Description	Default
`--r-version <R_VERSION>`	R version to install	`release`
`--num-workers <N>`	Parallel workers for `xfun::rev_check()`	All CPU cores
`--work-dir <WORK_DIR>`	Use a specific workspace directory	Current directory
`--skip-r-install`	Skip version resolution and installation; reuse system-wide R	Disabled

Inputs¶

revdeprun accepts three types of package inputs.

Git URL¶

revdeprun https://github.com/nanxstats/ggsci.git

The repository is cloned into the workspace clone root (by default, your current directory). Clones use --depth 1 for speed.

Local directory¶

revdeprun ~/packages/ggsci

The directory is used as-is. revdeprun will create revdep/ inside it.

Source tarball¶

revdeprun ~/packages/ggsci_4.0.0.tar.gz

The tarball is extracted into the workspace temp directory and used from there.

Monitor long-running checks¶

Reverse dependency checks can take hours to complete. Run them inside tmux on the remote Ubuntu instance so they keep running if your SSH connection drops or your local computer sleeps.

After connecting over SSH, install tmux and create a named session on the remote instance:

sudo apt-get update && sudo apt-get install -y tmux
tmux new-session -s revdeprun

Inside that session, start your check:

revdeprun https://github.com/nanxstats/ggsci.git

To detach while checks continue, press Ctrl+b, release both keys, then press d. You can now disconnect from SSH. After reconnecting to the same instance as the same user, reattach to see progress:

tmux attach-session -t revdeprun

Keep the remote instance running until checks finish. A tmux session does not survive a reboot or instance shutdown.

Bundle¶

revdeprun bundle [OPTIONS] [PACKAGE_DIR]

Name	Description	Default
`[PACKAGE_DIR]`	Package directory where `xfun::rev_check()` ran	`.`
`-o, --output <FILE>`	Output archive path; an existing directory receives the default file name	`<package>-revdep.tar.zst` next to the package directory

The subcommand collects the files xfun::rev_check() left behind for review (00check_diffs.md, 00check_diffs.html, *.Rcheck/, and *.Rcheck2/) into one zstd-compressed tar archive and prints the scp and tar commands for copying and extracting it. The summary and commands are printed to stderr even without a terminal. The output must be outside the check result directories, including their symlink aliases. It refuses to overwrite an existing file and exits with an error when the directory contains no results. Point it at the package directory printed at the end of the check:

revdeprun bundle ggsci

See Transfer results for the full workflow.

Minimal, intentional repository edits¶

revdeprun tries hard not to modify the (local) source package. Two exceptions:

It creates revdep/ to hold the library for running reverse dependency checks.
It appends ^revdep$ to .Rbuildignore (if needed) so building the package doesn't accidentally include the whole revdep/ directory.