Skip to content

Add stdout plugin - #1064

Merged
ItsLemmy merged 1 commit into
noctalia-dev:mainfrom
tordex:stdout
Oct 19, 2026
Merged

ItsLemmy merged 1 commit into
noctalia-dev:mainfrom
tordex:stdout

Conversation

@tordex

@tordex tordex commented Oct 19, 2026

Copy link
Copy Markdown
Contributor

Plugin

  • Id: tordex/stdout
  • New plugin
  • Update to an existing plugin (version bumped in plugin.toml)

What it does

Run a command periodically and display its output as bar widget text.

External dependencies

None

Testing

  • Tested on Niri
  • Tested on Hyprland
  • Tested on Sway
  • Tested on another compositor: Umbriel
  • Noctalia version tested against: noctalia v5.3.0 (aa0aa81)
  • Plugin API level: 28

Screenshots / Videos

Checklist

Ready-for-review requirement: Every box in this section must be checked. If any statement is not true, keep the
pull request as Draft. An explanation does not replace a required check.

  • The directory name matches the part of id after the / in plugin.toml exactly.
  • It ships plugin.toml, README.md, thumbnail.webp, and translations/en.json.
  • README.md follows the
    README template, documents
    every entry id and dependency, and includes exact panel IPC commands and launcher prefixes where applicable.
  • thumbnail.webp is present and relevant; for a new plugin I created it with the thumbnail generator, and for an update I regenerated it with the generator if the visual identity or user-facing appearance changed.
  • version follows semver and is bumped in this PR; plugin_api is the oldest API level this plugin requires.
  • Every non-English translation in this PR uses a locale supported by Noctalia core, and I can read, write, and
    understand that language well enough to review and maintain it (no unreviewed machine/LLM translations).
  • I did not edit catalog.toml; CI generates it.
  • This PR touches exactly one plugin directory.

Code review attestation

Plugins run as trusted, unsandboxed Luau in the user's session. Confirm:
Ready-for-review requirement: Every attestation below must be checked.

  • The code is readable and not obfuscated, minified, or generated.
  • It does not download and execute remote code.
  • Every network call, filesystem write, and spawned process is something the description above accounts for.
  • I have the right to publish this code under the license declared in plugin.toml.

@ItsLemmy

Copy link
Copy Markdown
Member
  1. non-blocking - stdout/bar.luau:152
    The documented force-refresh IPC calls update(), which enforces the configured interval. After a completed run, IPC does nothing until that interval expires, unlike right-click refresh. Call run_script() here to match the promise in stdout/README.md:24.

  2. non-blocking - stdout/README.md:18
    The Bluetooth example requires bluetoothctl and jq, but the requirements section says there are no other dependencies and the example description omits jq. Document these as optional dependencies for stdout/examples/stdout-bt-battery.sh:21 and stdout/examples/stdout-bt-battery.sh:75.

@ItsLemmy
ItsLemmy merged commit 2ea5014 into noctalia-dev:main Oct 19, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants