public release! 🎉

.envrc

@@ -0,0 +1 @@
+use flake .#  --impure

.github/workflows/nix.yml

@@ -0,0 +1,35 @@
+name: Build & Test
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write # write required for action-gh-release
+      id-token: write
+    steps:
+      - uses: DeterminateSystems/nix-installer-action@main
+      - uses: DeterminateSystems/magic-nix-cache-action@main
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Run `nix fmt`
+        run: nix fmt -- --check *
+      - name: Run `flake checks`
+        run: nix flake check -L
+      - name: Create AppImage
+        run: nix build .#isd-AppImage
+      # Leads to:
+      # `cannot write uid_map: Operation not permitted`
+      # - name: Test appimage
+      #   run: ./result --help
+      - name: Rename AppImage
+        if: startsWith(github.ref, 'refs/tags/')
+        run: cp ./result isd.AppImage
+      - name: Release AppImage
+        uses: softprops/action-gh-release@v2
+        if: startsWith(github.ref, 'refs/tags/')
+        with:
+          files: isd.AppImage

.gitignore

@@ -0,0 +1,176 @@
+.helix/
+schema.json
+config.yaml
+result
+# config should be automatically generated when running vhs!
+docs/config/*
+# same for .cast/gif files!
+*.cast
+*.gif
+*.mp4
+*.webm
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+.~lock.*
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+.devenv/
+.direnv/
+*.out

README.md

@@ -0,0 +1,70 @@
+# isd -- *i*nteractive *s*ystem*d*
+
+<!-- --8<-- [start:tagline] -->
+> `isd` — A Better Way to Work with `systemd` Units
+
+Simplify `systemd` management with `isd`!
+`isd` is a TUI offering fuzzy search for units, auto-refreshing previews,
+smart `sudo` handling, and a fully customizeable interface
+for power-users and newcomers alike.
+<!-- --8<-- [end:tagline] -->
+
+<!-- --8<-- [start:features] -->
+`isd` is a keyboard-focused, highly customizeable TUI with the following features:
+
+- Quickly switch between `system` and `user` units
+- Fuzzy search units
+- Auto refresh previews
+- Quickly open outputs in a pager or editor
+- Auto `sudo` prefixing if required
+- Auto rescale depending on terminal window size (fluid design)
+- Extensive command palette with many keyboard shortcuts
+- Fully configurable keybindings
+- Optional input state caching for common inputs
+- Theme support
+- YAML configuration file _with auto-complete_
+<!-- --8<-- [end:features] -->
+
+## Demo
+
+https://github.com/user-attachments/assets/4aad0902-6094-4fc2-90b9-b62456df22f5
+
+[Click here for a higher quality recording](https://isd-project.github.com/isd/#working-with-isd).
+
+## Documentation
+
+The documentation is live at:
+
+- <https://isd-project.github.io/isd>
+
+## Road map
+
+<!-- --8<-- [start:roadmap] -->
+A collection of some _unordered_ ideas that could improve `isd`:
+
+- [ ] Option to view the security rating of units
+- [ ] Improve highlighting of `systemd` units (tree-sitter grammar)
+- [ ] Write a custom, more secure `$EDITOR` integration (more secure `sytemctl edit`)
+- [ ] Add icon for project and application menu
+- [ ] Allow customization of preview windows
+- [ ] Improve `journal_pager` integration
+- [ ] Add custom sort options
+- [ ] Faster fuzzy search
+- [ ] Improve default themes
+<!-- --8<-- [end:roadmap] -->
+
+
+## Acknowledgments
+
+<!-- --8<-- [start:acknowledgments] -->
+Big thanks to the developers of:
+
+- [systemd](https://systemd.io/) for creating the most widely used service manager for Linux
+- [NixOS](https://nixos.org/) for peeking my interest in `systemd` and service managers
+- [`sysz`](https://github.com/joehillen/sysz) for providing a starting point and a desire to build a more complex `systemctl` TUI
+- [textual](https://textual.textualize.io/) for making it a breeze to create TUI's in Python
+- [mkdocs-material](https://squidfunk.github.io/mkdocs-material/) for building a solid and simple to use static site generator for the documentation
+- [asciinema](https://docs.asciinema.org/) for developing an easy to use _and self-hosteable_ terminal recorder and player
+- [vhs](https://github.com/charmbracelet/vhs) for creating a scriptable terminal program
+<!-- --8<-- [end:acknowledgments] -->
+