Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/joehillen/sysz

An fzf terminal UI for systemctl
https://github.com/joehillen/sysz

bash bash-script cli fzf systemctl systemd tui

Last synced: about 1 month ago
JSON representation

An fzf terminal UI for systemctl

Awesome Lists containing this project

README

        

# [sysz](https://github.com/joehillen/sysz)

A [fzf](https://github.com/junegunn/fzf) terminal UI for systemctl

Console - Developer Tool of the Week

# Demo

[![asciicast](https://asciinema.org/a/BLsJz73uF7DdQj7FVGqLPhqCa.svg)](https://asciinema.org/a/BLsJz73uF7DdQj7FVGqLPhqCa)

# Features

VERSION: 1.4.3

- See and filter both system and user units simultaneously.
- Supports all unit types.
- Units ordered by service, timer, socket, and the rest.
- Runs `sudo` automatically and only if necessary.
- Filter units by state using `ctrl-s` or the `--state` option.
- Run `daemon-reload` with `ctrl-r`.
- Has short versions of systemctl commands to reduce typing.
- Runs status after other commands (start, stop, restart, etc).
- Select multiple units, states, and commands using `TAB`.
- Only prompts commands based on current state
(e.g. show "start" only if the unit is inactive).

# Requirements

- [fzf](https://github.com/junegunn/fzf) >= [0.27.1](https://github.com/junegunn/fzf/blob/master/CHANGELOG.md#0244)
- bash > 4.3 (released 2009)
- awk

# Installation

## Arch Linux

```
paru -S sysz
```

## NixOS

```
nix-env -iA nixos.sysz
```

## Using Nix

```
nix-env -iA nixpkgs.sysz
```

## Using [`bin`](https://github.com/marcosnils/bin)

```
bin install https://github.com/joehillen/sysz
```

## Direct Download

```sh
wget -O ~/.bin/sysz https://github.com/joehillen/sysz/releases/latest/download/sysz
chmod +x ~/.bin/sysz
```

## From Source

```sh
git clone https://github.com/joehillen/sysz.git
cd sysz
sudo make install # /usr/local/bin/sysz
```

# Usage

```text
A utility for using systemctl interactively via fzf.

Usage: sysz [OPTS...] [CMD] [-- ARGS...]

sudo is invoked automatically, if necessary.

If only one unit is chosen, available commands will be presented
based on the state of the unit (e.g. "start" only shows if unit is "active").

OPTS:
-u, --user Only show --user units
--sys, --system Only show --system units
-s STATE, --state STATE Only show units in STATE (repeatable)
-V, --verbose Print the systemctl command
-v, --version Print the version
-h, --help Print this message

If no options are given, both system and user units are shown.

CMD:
start systemctl start
stop systemctl stop
r, restart systemctl restart
s, stat, status systemctl status
ed, edit systemctl edit
reload systemctl reload
en, enable systemctl enable
d, dis, disable systemctl disable
c, cat systemctl cat

If no command is given, one or more can be chosen interactively.

ARGS are passed to the systemctl command for each selected unit.

Keybindings:
TAB Toggle selection.
ctrl-v 'cat' the unit in the preview window.
ctrl-s Select states to match. Selection is reset.
ctrl-r Run daemon-reload. Selection is reset.
ctrl-p History previous.
ctrl-n History next.
? Show keybindings.

History:
sysz is stored in $XDG_CACHE_HOME/sysz/history
This can be changed with the environment variable: SYSZ_HISTORY

Some units are colored based on state:
green active
red failed
yellow not-found

Examples:
sysz -u User units
sysz --sys -s active Active system units
sysz --user --state failed Failed user units

Examples with commands:
sysz start Start a unit
sysz --sys s Get the status of system units
sysz --user edit Edit user units
sysz s -- -n100 Show status with 100 log lines
sysz --sys -s active stop Stop an active system unit
sysz -u --state failed r Restart failed user units
```

# Acknowledgements

Inspired by [fuzzy-sys](https://github.com/NullSense/fuzzy-sys) by [NullSense](https://github.com/NullSense/)

Thank you for [ShellCheck](https://github.com/koalaman/shellcheck) without which this would be a buggy mess.