Fish Oh My Fish

ID

oh-my-fish

Home page

https://github.com/oh-my-fish/oh-my-fish

Version requirement

>= 6

Platforms

🐧 Linux · 🍎 macOS

Operations

installed · install · upgrade · upgrade_all · remove

purl types

pkg:oh-my-fish

CLI name

fish

Forced environment

NO_COLOR=1

Issues and PRs

📦 manager: fish-based

Source

meta_package_manager/managers/oh_my_fish.py

Oh My Fish is a framework and plugin manager for the Fish shell.

Packages are cloned under $OMF_PATH and recorded in the user’s bundle file. Oh My Fish manages two kinds of package, plugins and themes, and reports both from one listing: mpm yields them together, since a name is unique across the two and every mutating command takes either.

Caution

omf is a Fish function, not a standalone binary: it is defined by sourcing $OMF_PATH/init.fish, so it cannot serve as the manager’s CLI. Every invocation is therefore wrapped in fish -c. Fish is the binary mpm executes, and Oh My Fish’s own presence is established by the version probe: a host with Fish but no Oh My Fish fails to source and reports no version, which leaves the manager unavailable.

Note

No outdated: Oh My Fish compares nothing against its remotes short of performing the update. upgrade --all still works, and mpm auto-skips the operation.

Note

No search: omf search exists and would map cleanly, but its results are printed by a private __omf.cli.search.output helper whose format no upstream sample pins down, so declaring it would mean guessing at a parser.

Documentation: Oh My Fish.

What mpm adds to oh-my-fish

mpm reaches across every manager at once, not oh-my-fish alone: mpm installed and mpm outdated cover oh-my-fish alongside every other manager you run in one table, mpm upgrade --all updates them together, and mpm sbom exports the whole machine as one bill of materials.

Every mpm command also gains --dry-run and --plan previews, cross-scheme version comparison and purl identifiers. See manager augmentations for how each one is built.

Your oh-my-fish commands, in mpm

You already know oh-my-fish: each operation maps one-to-one onto mpm, in an interface shared by every manager.

To…

With oh-my-fish

With mpm

Install a package

omf install z

mpm install pkg:oh-my-fish/z

Upgrade one package

omf update z

mpm --oh-my-fish upgrade z

Upgrade everything

omf update

mpm --oh-my-fish upgrade --all

Remove a package

omf remove z

mpm remove pkg:oh-my-fish/z

Prefix any command above with --dry-run to simulate the underlying manager calls without touching the system: the safe way to watch what mpm would do before trusting it.

Operations

Operation

Supported

installed

outdated

orphans

search

install

upgrade

upgrade_all

remove

sync

cleanup

doctor

Selecting and configuring oh-my-fish

Deselect oh-my-fish for a single run with --no-oh-my-fish, or persist the choice in your configuration:

[mpm]
oh-my-fish = false

The arguments and environment variables listed in the box atop this page are forced on every oh-my-fish call, so runs stay quiet, non-interactive and reproducible: the defaults you would set in CI anyway.

Keep it enabled but tune how mpm drives it with a per-manager override:

[mpm.managers.oh-my-fish]
timeout = 900

mpm config-template oh-my-fish prints every overridable attribute as a ready-to-paste block.

Recipes

A few jobs you would otherwise script around oh-my-fish, one mpm command each:

  • Snapshot and clone a machine: mpm --oh-my-fish dump oh-my-fish.toml, then mpm restore oh-my-fish.toml on the next one.

  • Export a compliance SBOM: mpm --oh-my-fish sbom (CycloneDX by default, --spdx for SPDX).

Privilege escalation

mpm runs this manager as the current user and never prepends sudo by default. Flip the policy for its privileged operations with --sudo or the per-manager sudo override.

See privilege escalation for the full policy.

Cooldown

State of Fish Oh My Fish’s release-age gating, from the cooldown support table:

Status: ❌ None (clones a Git branch or tag, no release feed)

A cooldown only pays off where a compromised release can be withdrawn while the clock runs, and can only be emulated where the registry dates its releases. From the retraction table:

  • Registry: Upstream Git clones

  • Retraction: None: a plugin is cloned straight from its upstream repository, so withdrawing a bad revision is its author force-pushing, retagging or deleting it themselves. No index sits in between

  • Publish date: ❌ a commit or tag date is set by the author and freely rewritable

With --cooldown set, mpm skips this manager’s install and upgrade operations rather than run them unguarded (fail-closed); --allow-unsupported-managers opts back in.

Version probe

The version is probed by running:

$ fish --version
Oh My Fish version 7

and extracted with:

r"Oh My Fish version (?P<version>\S+)"

Changelog

  • 7.7.0.dev0 (unreleased)

    • Add the Oh My Fish framework with installed, install, upgrade and remove support. Fish is the CLI mpm executes, since Oh My Fish ships as a sourced shell function rather than an executable.