Skip to content

Latest commit

 

History

History
68 lines (42 loc) · 2.04 KB

README.md

File metadata and controls

68 lines (42 loc) · 2.04 KB

node-auto-launch

NPM version Build Status Windows Build Status Dependency Status


Launch applications or executables at login (Mac, Windows and Linux). Perfect for NW.js and Electron apps.

Installation

npm install auto-launch

Usage

The API consists only of enable, disable, and isEnabled.

var AutoLaunch = require('auto-launch');

var minecraftAutoLauncher = new AutoLaunch({
	name: 'Minecraft',
	path: '/Applications/Minecraft.app',
	isHidden: true // hidden on launch - only works on a mac atm.
});

minecraftAutoLauncher.enable();
//minecraftAutoLauncher.disable();

For NW.js or Electron apps you don't have to specify the path. It gets read from process.execPath :)

var AutoLaunch = require('auto-launch');

var appLauncher = new AutoLaunch({
	name: 'My NW.js or Electron app'
});

appLauncher.isEnabled(function(enabled){
	if(enabled) return;

	appLauncher.enable(function(err){

	});

});

Note: I added a method (removeNwjsLoginItem) to remove 'nwjs helper' app login item that might have been added to peoples accounts since the name change from node-webkit to NW.js.

TODO:

  • Add getCurrentPath - So you can check if the app has moved around.