motd_forge 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4f464272c1529564c2149c1ca24df6cfcc2206abed5339a63cbaf024411e16a2
+  data.tar.gz: b36d08dacd1857f2d4d40d06b23d31ed9274b6cfebe0e2a0a190455da24cf071
+SHA512:
+  metadata.gz: 64a34ddd860c4fd8f26146b7db2617fd53144f03e9822f809bd3865c2e131114c61a5e1b8e4c6b20e4301d9b00a96c81fdbc9f883fb1a3394807a6c94111f1cd
+  data.tar.gz: d17e49efd869e98c0c975e90f31abba782ba8ab196b811171804eacc39fea4c4b8d32d530e1f0cef8e6791ff30695a12ceba0d0ca03d9343adbe4a315bc2ab8b

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## [Unreleased]
+
+- Initial release: banner rendering, system stats, quotes, CLI, YAML config support.

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Zach Schneider
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,50 @@
+# motd-forge
+
+Generate a randomized login banner (MOTD) for your servers: a title (rendered
+big via `figlet` if it's installed, plain text otherwise), current uptime,
+disk and memory usage, and a random quote.
+
+## Installation
+
+    $ gem install motd_forge
+
+Or from source:
+
+    $ bundle install
+    $ rake install
+
+## Usage
+
+    $ motd-forge
+    $ motd-forge --name mybox
+    $ motd-forge --quote-file ~/.motd-quotes.txt
+    $ motd-forge --no-quote
+
+Run `motd-forge --help` for the full list of options.
+
+### Config file
+
+Settings can also live in `~/.motd-forge.yml` (or a path passed via `--config`):
+
+    title: mybox
+    quote_file: ~/.motd-quotes.txt
+
+CLI flags take precedence over the config file.
+
+### Wiring it into a login banner
+
+Add a call to `motd-forge` from `/etc/profile.d/motd-forge.sh` (or your
+shell's rc file) so it prints on every SSH login:
+
+    #!/bin/sh
+    motd-forge
+
+## Development
+
+    $ bundle install
+    $ rake spec        # run the test suite
+    $ bin/console       # interactive prompt
+
+## License
+
+MIT

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/exe/motd-forge

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "motd_forge"
+
+exit(MotdForge::CLI.run)

data/lib/motd_forge/banner.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require "shellwords"
+
+module MotdForge
+  # Composes the final banner: a big title (via `figlet` if it's installed,
+  # else a plain bordered header), system stats, and a random quote.
+  class Banner
+    def initialize(title:, stats: SystemStats.capture, quote: Quotes.new.pick)
+      @title = title
+      @stats = stats
+      @quote = quote
+    end
+
+    def render
+      [render_title, render_stats, render_quote].compact.join("\n")
+    end
+
+    private
+
+    def render_title
+      figlet_title || plain_title
+    end
+
+    def figlet_title
+      return unless figlet_available?
+
+      output = `figlet #{Shellwords.escape(@title)} 2>/dev/null`
+      output.empty? ? nil : output.rstrip
+    end
+
+    def figlet_available?
+      return @figlet_available if defined?(@figlet_available)
+
+      @figlet_available = system("which figlet > /dev/null 2>&1")
+    end
+
+    def plain_title
+      border = "=" * (@title.length + 4)
+      "#{border}\n| #{@title} |\n#{border}"
+    end
+
+    def render_stats
+      "Uptime: #{@stats.uptime} | " \
+        "Disk: #{@stats.disk_usage_percent} used | " \
+        "Mem: #{@stats.mem_used}/#{@stats.mem_total} (#{@stats.mem_used_percent})"
+    end
+
+    def render_quote
+      %("#{@quote}") if @quote
+    end
+  end
+end

data/lib/motd_forge/cli.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require "optparse"
+require "yaml"
+require "socket"
+
+module MotdForge
+  # Parses CLI flags, merges in an optional YAML config, and prints the banner.
+  class CLI
+    DEFAULT_CONFIG_PATH = File.expand_path("~/.motd-forge.yml")
+
+    def self.run(argv = ARGV)
+      new(argv).run
+    end
+
+    def initialize(argv)
+      @argv = argv
+      @title = Socket.gethostname
+      @title_from_cli = false
+      @quote_file = nil
+      @show_quote = true
+      @config_path = DEFAULT_CONFIG_PATH
+    end
+
+    def run
+      parse_options!
+      load_config!
+
+      quote = @show_quote ? Quotes.new(file: @quote_file).pick : nil
+      puts Banner.new(title: @title, quote: quote).render
+      0
+    end
+
+    private
+
+    def parse_options!
+      OptionParser.new do |opts|
+        opts.banner = "Usage: motd-forge [options]"
+
+        opts.on("-n", "--name NAME", "Title to render (default: hostname)") do |v|
+          @title = v
+          @title_from_cli = true
+        end
+        opts.on("-q", "--quote-file FILE", "Custom quotes file, one per line") { |v| @quote_file = v }
+        opts.on("--no-quote", "Don't print a quote") { @show_quote = false }
+        opts.on("-c", "--config FILE", "Config file (default: #{DEFAULT_CONFIG_PATH})") { |v| @config_path = v }
+        opts.on("-v", "--version", "Print the version") do
+          puts MotdForge::VERSION
+          exit 0
+        end
+        opts.on("-h", "--help", "Print this help") do
+          puts opts
+          exit 0
+        end
+      end.parse!(@argv)
+    end
+
+    def load_config!
+      return unless File.exist?(@config_path)
+
+      config = YAML.safe_load(File.read(@config_path)) || {}
+      @title = config["title"] if config["title"] && !@title_from_cli
+      @quote_file ||= config["quote_file"]
+    rescue Psych::SyntaxError
+      warn "motd-forge: ignoring invalid config at #{@config_path}"
+    end
+  end
+end

data/lib/motd_forge/quotes.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module MotdForge
+  # Picks a random quote to print under the banner. Ships with a small
+  # built-in set and can be extended with a plain-text file, one quote per line.
+  class Quotes
+    DEFAULT = [
+      "It's not a bug, it's an undocumented feature.",
+      "There's no place like 127.0.0.1.",
+      "Rebooting the router fixes everything, eventually.",
+      "In case of fire: git commit, git push, then evacuate.",
+      "99 little bugs in the code, 99 little bugs...",
+      "The cloud is just someone else's computer. This one's yours."
+    ].freeze
+
+    def initialize(file: nil)
+      @file = file
+    end
+
+    def pick
+      pool.sample
+    end
+
+    private
+
+    def pool
+      return DEFAULT unless @file
+
+      lines = File.readlines(@file, chomp: true).reject(&:empty?)
+      lines.empty? ? DEFAULT : lines
+    rescue Errno::ENOENT
+      DEFAULT
+    end
+  end
+end

data/lib/motd_forge/system_stats.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module MotdForge
+  # Reads uptime, disk, and memory usage from the host. Uses /proc on Linux,
+  # with a best-effort shell fallback (e.g. `uptime`) elsewhere.
+  class SystemStats
+    Snapshot = Struct.new(:uptime, :disk_usage_percent, :mem_used, :mem_total, :mem_used_percent)
+
+    def self.capture
+      new.capture
+    end
+
+    def capture
+      Snapshot.new(uptime, disk_usage_percent, *memory)
+    end
+
+    private
+
+    def uptime
+      seconds = File.read("/proc/uptime").split.first.to_f
+      format_duration(seconds)
+    rescue Errno::ENOENT
+      shell_uptime
+    end
+
+    def format_duration(seconds)
+      days, rem = seconds.divmod(86_400)
+      hours, rem = rem.divmod(3_600)
+      minutes, = rem.divmod(60)
+
+      parts = []
+      parts << "#{days.to_i}d" if days.positive?
+      parts << "#{hours.to_i}h" if hours.positive? || days.positive?
+      parts << "#{minutes.to_i}m"
+      parts.join(" ")
+    end
+
+    def shell_uptime
+      `uptime -p`.strip.sub(/\Aup /, "")
+    rescue StandardError
+      "unknown"
+    end
+
+    def disk_usage_percent(path = "/")
+      line = `df -kP #{path} 2>/dev/null`.lines[1]
+      return "unknown" unless line
+
+      line.split[4]
+    rescue StandardError
+      "unknown"
+    end
+
+    def memory
+      meminfo = File.read("/proc/meminfo")
+      total_kb = meminfo[/MemTotal:\s+(\d+)/, 1].to_i
+      available_kb = meminfo[/MemAvailable:\s+(\d+)/, 1].to_i
+      used_kb = total_kb - available_kb
+
+      percent = total_kb.positive? ? ((used_kb.to_f / total_kb) * 100).round : 0
+      [kb_to_human(used_kb), kb_to_human(total_kb), "#{percent}%"]
+    rescue Errno::ENOENT
+      %w[unknown unknown unknown]
+    end
+
+    def kb_to_human(kb)
+      gb = kb / 1024.0 / 1024.0
+      return "#{gb.round(1)}G" if gb >= 1
+
+      "#{(kb / 1024.0).round}M"
+    end
+  end
+end

data/lib/motd_forge/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module MotdForge
+  VERSION = "0.1.0"
+end

data/lib/motd_forge.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative "motd_forge/version"
+require_relative "motd_forge/system_stats"
+require_relative "motd_forge/quotes"
+require_relative "motd_forge/banner"
+require_relative "motd_forge/cli"
+
+module MotdForge
+  class Error < StandardError; end
+end

data/motd_forge.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "lib/motd_forge/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "motd_forge"
+  spec.version = MotdForge::VERSION
+  spec.authors = ["Zach Schneider"]
+  spec.email = ["zachschneider@gmail.com"]
+
+  spec.summary = "Generate a randomized login banner (MOTD) with system stats and a quote."
+  spec.description = "motd-forge builds a custom message-of-the-day banner showing uptime, " \
+                      "disk and memory usage, and a random quote -- handy for homelab servers."
+  spec.homepage = "https://github.com/zkm/motd_forge"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  spec.files = Dir.glob("{lib,exe}/**/*") +
+               %w[README.md LICENSE.txt CHANGELOG.md motd_forge.gemspec Gemfile Rakefile]
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "erb"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.13"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: motd_forge
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Zach Schneider
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: erb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+description: motd-forge builds a custom message-of-the-day banner showing uptime,
+  disk and memory usage, and a random quote -- handy for homelab servers.
+email:
+- zachschneider@gmail.com
+executables:
+- motd-forge
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/motd-forge
+- lib/motd_forge.rb
+- lib/motd_forge/banner.rb
+- lib/motd_forge/cli.rb
+- lib/motd_forge/quotes.rb
+- lib/motd_forge/system_stats.rb
+- lib/motd_forge/version.rb
+- motd_forge.gemspec
+homepage: https://github.com/zkm/motd_forge
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/zkm/motd_forge
+  source_code_uri: https://github.com/zkm/motd_forge
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Generate a randomized login banner (MOTD) with system stats and a quote.
+test_files: []