meta_package_manager.managers.sfsu module¶

class meta_package_manager.managers.sfsu.SFSU[source]¶

Bases: PackageManager

sfsu (Stupid Fast Scoop Utils) is a Rust reimplementation of Scoop’s slower read paths, working against the same buckets and ~/scoop install tree.

mpm reaches for sfsu only where it is both faster than Scoop and speaks JSON: installed, outdated and search all pass --json and are parsed as structured objects instead of the whitespace tables Scoop prints.

Initialize cli_errors list.

maintenance_note: str | None = 'Since 2026-09-21, the sfsu readme [looks for maintainers](https://github.com/orgs/winpax/discussions/958): its author no longer runs Windows, and commits only to bug fixes and parity with Scoop. It points to [hok](https://github.com/chawyehsu/hok) as an alternative.'¶

A watch note about a still-maintained upstream whose activity is slowing or whose status is ambiguous, as a MyST markdown block.

Unlike unmaintained, this is purely informational: the manager stays in the default selection and in the test matrices. It renders as a {note} admonition atop the manager’s documentation page, flagging upstreams worth keeping an eye on (a slow release cadence, superseded-but-still-shipped tools, a discontinued platform still under vendor support). May embed markdown links. Mutually exclusive with unmaintained: a confirmed-dead manager carries an unmaintained_message instead. Enforced by test_maintenance_note.

operation_notes: ClassVar = {'install': 'The tool ships no mutating verb, so the operation runs the `scoop` binary instead.', 'remove': 'The tool ships no mutating verb, so the operation runs the `scoop` binary instead.', 'upgrade': 'The tool ships no mutating verb, so the operation runs the `scoop` binary instead.', 'upgrade_all': 'The tool ships no mutating verb, so the operation runs the `scoop` binary instead.'}¶

Per-operation hints rendered in the Notes column of the manager page’s Operations table.

Keyed by the Operations member name, each value is a single short sentence explaining why the manager lacks the operation, or what makes its implementation partial: the pointer a reader needs to judge whether the gap is one they could help close. Each sentence starts with a capital and closes with a period, and starts on a word rather than a code span, so the cell reads standalone beside its row. A blank cell stays silent: a manager documenting nothing documents no gap.

The full rationale never lives here: it belongs in a comment beside the implementing method (or beside this declaration, for an operation with no method to hang it on), so the sentence on the page stays a hint and the code keeps the story. The class docstring follows the same split: it keeps only what a user needs to run the tool day to day, never how mpm wraps it.

Validated by test_operation_notes, which also checks every key matches a real operation: a key outside the enum’s vocabulary would never reach a page.

name: str = 'Scoop sfsu'¶

Return package manager’s common name.

Default value is based on class name.

repository_url: str | None = 'https://github.com/winpax/sfsu'¶

Repository holding the project’s code, or None when it has no public one.

Linked from the manager’s documentation page. Also what the weekly metrics sample reads: docs/docs_update.py writes it into the [tool.repomatic.metrics] subjects of pyproject.toml when its forge answers the sampler, through a mirror for a forge that does not.

Never inherited, for the same reason as wikipedia_url: the AUR helpers extending pacman each live in a repository of their own.

platforms: frozenset[Platform] | Group | Platform | Iterable[Platform | Group] = frozenset({Platform(id='windows', name='Windows')})¶

List of platforms supported by the manager.

Allows for a mishmash of platforms and groups of platforms. Will be normalized into a frozenset of Platform instances at instantiation.

requirement: str | None = '>=1.16.0'¶

Version requirement specifier.

Supports a comma-separated range of constraints (e.g. ">=1.20.0,<2.0.0"). A bare version string like "1.20.0" is treated as >=1.20.0.

Parsed by meta_package_manager.version.VersionRange.

Defaults to None, which deactivates version check entirely.

post_args: tuple[str, ...] = ('--no-color',)¶

Global list of options used before and after the invoked package manager CLI.

Automatically added to each meta_package_manager.execution.CLIExecutor.run_cli() call.

Essentially used to force silencing, low verbosity or no-color output.

version_regexes: tuple[str, ...] = ('sfsu\\s+(?P<version>\\S+)',)¶
> sfsu --version
sfsu 1.17.2
sprinkles 0.22.0 (crates.io published version)
property installed: Iterator[Package]¶

Fetch installed packages.

> sfsu list --json --no-color
[
  {
    "name": "7zip",
    "version": "26.00",
    "source": "main",
    "updated": "2026-03-18 17:54:32",
    "notes": ""
  },
  {
    "name": "git",
    "version": "2.53.0.3",
    "source": "main",
    "updated": "2026-03-15 09:12:04",
    "notes": ""
  }
]
property outdated: Iterator[Package]¶

Fetch outdated packages.

Uses sfsu status --only apps --json which returns packages with available updates.

> sfsu status --only apps --json --no-color
{
  "packages": [
    {
      "name": "git",
      "current": "2.53.0.2",
      "available": "2.53.0.3",
      "missing_dependencies": [],
      "info": null
    }
  ]
}
search(query, extended, exact)[source]¶

Fetch matching packages.

Caution

Search does not support extended or exact matching. Results are refiltered by meta_package_manager.manager.PackageManager.refiltered_search().

> sfsu search --json zoxide --no-color
{
  "main": [
    {
      "name": "zoxide",
      "bucket": "main",
      "version": "0.10.0",
      "installed": false,
      "bins": []
    }
  ]
}
Return type:

Iterator[Package]

install¶

Install one package.

A version installs the manifest that shipped it, which Scoop looks up in the bucket’s Git history before it falls back to generating one from the autoupdate rules of the current manifest.

> scoop install 7zip
Installing '7zip' (22.01) [64bit] from main bucket
7z2201-x64.msi (1.8 MB) [====================] 100%
Checking hash of 7z2201-x64.msi ... ok.
Extracting 7z2201-x64.msi ... done.
Linking ~\scoop\apps\7zip\current => ~\scoop\apps\7zip\22.01
Creating shim for '7z'.
Creating shortcut for 7-Zip (7zFM.exe)
Persisting Codecs
Persisting Formats
Running post_install script...
'7zip' (22.01) was installed successfully!

Notes
-----
Add 7-Zip as a context menu by running: "C:\scoop\...install-context.reg"
> scoop install hyperfine@1.18.0
INFO  Resolving historical manifest for 'hyperfine' (1.18.0)
Installing 'hyperfine' (1.18.0) [64bit] from generated manifest
Downloading https://github.com/sharkdp/hyperfine/releases/download/v1.18.0/hyperfine-v1.18.0-x86_64-pc-windows-msvc.zip (569.1 KB)...
Checking hash of hyperfine-v1.18.0-x86_64-pc-windows-msvc.zip... OK.
Extracting hyperfine-v1.18.0-x86_64-pc-windows-msvc.zip... Done.
Linking ~\scoop\apps\hyperfine\current => ~\scoop\apps\hyperfine\1.18.0
Creating shim for 'hyperfine'.
'hyperfine' (1.18.0) was installed successfully!
upgrade_all_cli¶

Generates the CLI to upgrade all outdated packages.

> scoop update --all
upgrade_one_cli¶

Generates the CLI to upgrade the provided package.

> scoop update 7zip
remove¶

Remove one package.

> scoop uninstall 7zip --purge
Uninstalling '7zip' (22.01).
Removing shim '7z.shim'.
Removing shim '7z.exe'.
Removing shortcut ~\AppData\Roaming\Scoop Apps-Zip.lnk
Unlinking ~\scoopppszip\current
'7zip' was uninstalled.
sync()[source]¶

Sync package metadata.

Uses sfsu’s native update command which updates Scoop and all buckets.

> sfsu update --no-color
Return type:

None

cleanup_cache()[source]¶

Removes old versions of all installed apps and clears the cache.

> sfsu cleanup --all --cache --no-color
Return type:

None

cli_names: tuple[str, ...] = ('sfsu',)¶

List of CLI names the package manager is known as.

This list of recognized CLI names is ordered by priority. That way we can influence the search of the right binary.

..hint::

This was helpful in the case of the Python transition from 2.x to 3.x, where multiple versions of the same executable were named python or python3.

By default, this property’s value is derived from the manager’s ID (see the MetaPackageManager.__init__ method above).

documentation_url: str | None = None¶

Entry point of the project’s own documentation, or None when it has none.

The manual, the documentation site, or the man page of the CLI mpm drives: whichever page a user reads to learn the commands this manager wraps. Listed between homepage_url and repository_url in the links of the manager’s page, so a reader reaching for the tool’s reference finds it in the box of facts rather than in the prose below it.

Left unset where a link would state a fact twice or invent one: a tool documenting itself in its repository alone, whose README repository_url already reaches. A page about the ecosystem rather than the tool does not qualify either.

Where a project’s only site is its manual, that address belongs here and homepage_url stays unset: the slot names what the page is, and a reader reaching for the reference looks under the documentation link.

Never inherited, like every other link: the AUR helpers extending pacman each document themselves.

homepage_url: str | None = None¶

Home page of the project, only used in documentation for reference.

Left unset when the home page is the project’s repository, which repository_url names on its own, and when it is the project’s manual, which documentation_url names. Never inherited, like the other links.

id: str = 'sfsu'¶

Package manager’s ID.

Derived by defaults from the lower-cased class name in which underscores _ are replaced by dashes -.

This ID must be unique among all package manager definitions and lower-case, as they’re used as feature flags for the mpm CLI.

virtual: bool = False¶

Should we expose the package manager to the user?

Virtual package manager are just skeleton classes used to factorize code among managers of the same family.

wikipedia_url: str | None = None¶

English Wikipedia article about the project, or None when it has none.

Listed last in the links of the manager’s documentation page. The article covers the project that home page names, or is a redirect Wikipedia keeps under the project’s name, landing on the part of a broader article that describes it: Cargo_(software) opens the Cargo section of the Rust article. An article that merely mentions the project does not count, nor does one about a related subject: lazy is a Neovim plugin manager, and the Neovim article is not about it.

Never inherited: the metaclass resets it to None on any class not declaring its own. A subclass often wraps a distinct project, like the six AUR helpers extending pacman, and would otherwise present pacman’s article as its own. Documentation-only, like homepage_url.