README¶

fish-kernel is a Jupyter kernel implementation for the fish shell.

Requirements¶

Python >=3.10
fish command available on PATH
Jupyter frontend (jupyterlab or notebook)
Supported OS: Linux, macOS, and Windows (WSL)
Native Windows is not supported (fish shell dependency)

Install¶

To register a Jupyter kernel, run a concrete install command such as:

fish-kernel add --user

If you want to install into the current Python environment instead, use:

fish-kernel add --sys-prefix

fish-kernel install is an alias of fish-kernel add, so either name works.

PyPI¶

pip install fish-kernel

conda-forge¶

Install from the conda-forge channel with conda, mamba, or pixi:

conda install -c conda-forge fish-kernel

mamba install -c conda-forge fish-kernel

pixi add fish-kernel

After installation, register the kernelspec.

fish-kernel add requires one of --user, --sys-prefix, or --prefix.

Install for your user account:

fish-kernel add --user

Or install into the current Python environment:

fish-kernel add --sys-prefix

After installation, verify the kernel is registered:

jupyter kernelspec list

You should see a fish kernel entry.

To unregister the kernelspec, run fish-kernel remove (or its alias fish-kernel uninstall).

Development¶

git clone https://github.com/eunos-1128/fish-kernel.git
cd fish-kernel
uv sync --dev
uv run pytest
uv run fish-kernel install --sys-prefix
uv run jupyter kernelspec list

Usage examples¶

Simple calculation:

set a 7
set b 13
math $a + $b

Acknowledgements¶

This project was developed with inspiration from: