sindresorhus / lock-system

Lock your system

lock-system

Lock your system

Shows the login screen the next time you use the computer.

Supports macOS, Linux, and Windows.

Install

npm install lock-system

Usage

import lockSystem from 'lock-system';

lockSystem();

API

lockSystem()

Locks the system.

Throws an error if executing the lock command fails or if the OS is not supported.

Related

• lock-cli - CLI for this module
• alfred-lock - Alfred workflow

lock-system's Issues

How does this compare to executing CGSession -suspend?

i.e., https://github.com/unixorn/tumult.plugin.zsh/blob/master/bin/lockscreen

is suspension different from SAC lock?

Provide source for macOS lock-binary or implement different method

The macOS lock-executable's source is currently not provided in the repository. Perhaps this could be added.

An alternative solution that doesn't require a binary would be to use child-process to execute the pmset displaysleepnow command. This will put the screen to sleep, which results in a lock if the user has set a log-in password and turned on "Require password after sleep or screen saver begins" in System Preferences, which should be the case anyway.

Example code

const { exec } = require('child_process');
exec('pmset displaysleepnow');

Request: add support for cinnamon

Would you accept a pr to add support for the Cinnamon desktop environment? It's one of the most popular linux desktops right after gnome, used initially by linux mint, and now shipped on several other distros.

Put `cinnamon-screensaver-command` first?

Hey, is there a particular reason for the order of Linux commands? The way that it's currently set, it actually doesn't work for me. My workstation seems to have xdg-screensaver, but no-ops when I try to run the command. The cinnamon command works.