Getting
Started

Welcome to the sanctuary of automation. Follow these steps to prepare your environment and architect your first macOS workflow.

Core Installation

Mjolnir is delivered as a lightweight macOS application. The most efficient way to install is via Homebrew.

brew install mjolnir

Manual download also available on GitHub.

Module Architecture

Unlike monolithic tools, Mjolnir requires you to install exactly what you need. We use LuaRocks for dependency management.

# Install the hotkey module
luarocks install mjolnir.hotkey

# Install the application control module
luarocks install mjolnir.application

Your First Script

Create the directory ~/.mjolnir/ and initialize your primary logic file.

~/.mjolnir/init.lua

local hotkey = require "mjolnir.hotkey"
local alert = require "mjolnir.alert"

-- Bind Cmd+Alt+Ctrl+H to show a welcome message
hotkey.bind({"cmd", "alt", "ctrl"}, "H", function()
  alert.show("Welcome to Mjolnir")
end)

After saving this file, select "Reload Configuration" from the Mjolnir menu bar icon.

Need Support?

Join our community of architects on IRC or GitHub if you encounter any anomalies during setup.

Join Community

Pro Tip

"Always check your Accessibility permissions in System Settings if your hotkeys fail to trigger."