Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 5 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,7 @@ process.</sub></p>
[Documentation](docs/README.md) ·
[Release status](docs/release-readiness.md)

`0.1.1-beta.16.3` is the target GitHub prerelease. AUR publication is
deferred; use the source installation below. See the
`0.1.1-beta.16.3` is the target GitHub prerelease. See the
[release notes](.github/release-notes/v0.1.1-beta.16.3.md) for changes and the
downgrade warning.
The current pinned host contracts use Omarchy and Omarchy Settings `4.0.4-1`
Expand Down Expand Up @@ -63,29 +62,19 @@ for the latest validated host versions.
## Install

> [!IMPORTANT]
> AUR publication is deferred; use the source installation below.
> Install from the release tag, not `main`. Shibumi supports Omarchy Quattro only.

After AUR publication, the supported one-command installation is:

```bash
omarchy pkg aur add shibumi-shell && shibumi-shell install --yes
```

Pacman resolves the required runtime packages and skips dependencies already
provided by the system. The explicit Shibumi command then stages and verifies
the 24 user plugins without a root package hook touching the user's config.

Install from source using the release tag:

```bash
sudo pacman -S --needed python jq curl networkmanager power-profiles-daemon upower xdg-utils libnotify wl-clipboard ttf-material-symbols-variable ttf-jetbrains-mono-nerd-basic noto-fonts-cjk adwaita-fonts
git clone https://github.com/HANCORE-linux/Shibumi-Shell.git
cd Shibumi-Shell
git checkout v0.1.1-beta.16.3
./scripts/shibumi-suite install --yes
```

The installer asks for root privileges only while Pacman installs missing
runtime commands and fonts; the Shibumi lifecycle itself runs as the desktop
user and writes only user-scoped plugin state.

Update an admitted Beta.16.2 source installation to Beta.16.3.
Exact predecessor identities, not a version range, govern admission; see the
[update guide](docs/install.md#update).
Expand All @@ -101,10 +90,6 @@ git checkout v0.1.1-beta.16.3

Do not install or update from `main`. If you previously installed from `main`, run `./scripts/shibumi-suite uninstall --keep-settings --yes` from that exact checkout before switching to a tag.

The source installation asks for root privileges only while Pacman
installs missing runtime commands and fonts. The Shibumi lifecycle itself runs
as the desktop user and writes only user-scoped plugin state.

[Installation, updates, recovery, and removal](docs/install.md)

### Uninstall
Expand Down
4 changes: 2 additions & 2 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,8 @@ Version `0.1.1-beta.13` is a published GitHub prerelease. Its exact package
payload and complete package lifecycle passed, including physical V1/V2,
stock-bar return, style, and top/bottom acceptance on single-output Omarchy
4.0.3. The validation machine exposed only `eDP-1`, so this is not multi-output
acceptance. AUR publication remains deferred. Shibumi supports Omarchy Quattro
only. The pinned source contracts and accepted host evidence are recorded in the
acceptance. Shibumi supports Omarchy Quattro only. The pinned source contracts
and accepted host evidence are recorded in the
[Shibumi host compatibility record](architecture/quattro-compatibility.md).

Read [release readiness](release-readiness.md) for the current evidence and
Expand Down
34 changes: 5 additions & 29 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,49 +6,26 @@ Shibumi installs 24 independent plugin roots into Omarchy's normal plugin
directory. The repository root is a suite source, not a single installable
Omarchy plugin.

`0.1.1-beta.16.3` is the target GitHub prerelease. AUR publication is
deferred; install from the release tag using the source workflow below.
`0.1.1-beta.16.3` is the target GitHub prerelease. Install from the release
tag using the source workflow below.
Do not install or update from `main`.

## Requirements

- Omarchy Quattro; other Omarchy generations are not supported
- The package workflow installs required commands and fonts through Pacman and
- The source workflow installs required commands and fonts through Pacman and
skips dependencies that are already installed or provided
- The source workflow additionally needs Git, HTTPS access to the repository,
- The source workflow also needs Git, HTTPS access to the repository,
and a trusted local checkout

The exact accepted Omarchy and Quickshell packages are recorded in the
[Shibumi host compatibility record](architecture/quattro-compatibility.md).

## Install from the Arch package

> [!NOTE]
> AUR publication is deferred. Use this package workflow once the package
> is available from AUR; use the source workflow below in the meantime.

```bash
omarchy pkg aur add shibumi-shell && shibumi-shell install --yes
```

The package manager installs immutable files under `/usr/share/shibumi-shell`
and the stable `/usr/bin/shibumi-shell` command. It does not run an install
hook, select a desktop user, edit `shell.json`, or copy plugins into a home
directory. The unprivileged `shibumi-shell install` transaction performs those
user-scoped operations explicitly and verifies the resulting Quattro runtime.

Preview the same setup without changing user state:

```bash
shibumi-shell install --dry-run
```

## Install from source

For an intentional non-interactive installation:

```bash
sudo pacman -S --needed python jq curl networkmanager power-profiles-daemon upower xdg-utils libnotify wl-clipboard ttf-material-symbols-variable ttf-jetbrains-mono-nerd-basic noto-fonts-cjk adwaita-fonts
git clone https://github.com/HANCORE-linux/Shibumi-Shell.git
cd Shibumi-Shell
git checkout v0.1.1-beta.16.3
Expand Down Expand Up @@ -436,5 +413,4 @@ committing a transaction.

Shibumi does not fetch its own source updates. For a source installation,
update only from a trusted checkout. Package update checks are read-only and package
installation remains owned by Omarchy/Pacman. The AUR boundary is documented in
[packaging and AUR strategy](development/packaging.md).
installation remains owned by Omarchy/Pacman.
13 changes: 2 additions & 11 deletions tests/documentation-regression.py
Original file line number Diff line number Diff line change
Expand Up @@ -130,8 +130,6 @@ def verify_source_install_block(block: str) -> None:
f"{execution.stderr.strip()}"
)
calls = log_path.read_text(encoding="utf-8")
if "sudo:pacman -S --needed" not in calls:
fail("README source install did not invoke Pacman through sudo")
clone_call = "git:clone https://github.com/HANCORE-linux/Shibumi-Shell.git"
if clone_call not in calls:
fail("README source install did not invoke the documented clone")
Expand Down Expand Up @@ -343,23 +341,16 @@ def legacy_storage_error(documents: dict[str, str]) -> str | None:
fail(f"broken README image: {raw_target}")

bash_blocks = re.findall(r"```bash\n.*?\n```", readme, flags=re.DOTALL)
if len(bash_blocks) != 4:
if len(bash_blocks) != 3:
fail(
"README landing page must contain package/source install and "
"README landing page must contain source install and "
"package/source uninstall Bash blocks"
)
package_install_command = (
"omarchy pkg aur add shibumi-shell && shibumi-shell install --yes"
)
source_install_markers = (
"sudo pacman -S --needed",
"ttf-material-symbols-variable",
"git clone https://github.com/HANCORE-linux/Shibumi-Shell.git",
"cd Shibumi-Shell",
"./scripts/shibumi-suite install --yes",
)
if sum(package_install_command in block for block in bash_blocks) != 1:
fail("README landing page is missing the package install command")
source_install_blocks = [
block
for block in bash_blocks
Expand Down