Skip to content

User Guide

Leonard Ramminger edited this page May 6, 2026 · 3 revisions

User Guide

Home | Next: Getting Started

This section is for people who want to use ReqPack effectively. Focus here if your goal is installing packages, managing environments, auditing systems, exporting SBOMs, or automating package work through stdin or remote mode. In user commands, system means target ecosystem or plugin such as apt, dnf, npm, or rqp.

What ReqPack Is Good At

  • One command surface for multiple ecosystems.
  • Manifest-based installs through reqpack.lua.
  • Plugin wrapper refresh through a central registry.
  • Vulnerability audit and SBOM export.
  • Remote command execution through serve and remote.
  • Native rqp packages when you want ReqPack-managed artifacts instead of wrapping another package manager.

Fast Reading Path

  1. Getting Started
  2. Configuration
  3. Security, Audit, and SBOM
  4. Remote Mode
  5. Using Native rqp Packages

Common Tasks

Task Page Command or file
Install packages Getting Started ReqPack install apt curl git
Install from manifest Getting Started ReqPack install .
Tune config Configuration ~/.config/reqpack/config.lua
Audit vulnerabilities Security, Audit, and SBOM ReqPack audit .
Export SBOM Security, Audit, and SBOM ReqPack sbom --format cyclonedx-json --output sbom.json
Run server Remote Mode ReqPack serve --remote --token secret
Connect to server Remote Mode ReqPack remote dev list apt
Use native ReqPack packages Using Native rqp Packages ReqPack install rqp my-tool

Mental Model

ReqPack is not trying to replace every package manager with one storage format. Instead, it does three different jobs:

  1. It gives users a consistent CLI.
  2. It delegates ecosystem-specific work to plugins.
  3. It adds shared capabilities around that work: config, planning, audit, SBOM, snapshots, remote execution, and history.

That means you will often use ReqPack in one of two modes:

  • Wrapper mode: apt, dnf, brew, npm, maven, sys, and similar ecosystems.
  • Native mode: rqp, where packages and repositories are managed directly by ReqPack.

Related Pages

Home | Next: Getting Started

Clone this wiki locally