Skip to content

Latest commit

 

History

History
67 lines (47 loc) · 1.89 KB

README.md

File metadata and controls

67 lines (47 loc) · 1.89 KB

node-startup-manager

npm version

Manage Startup tasks for OSX, Windows & Linux (Ubuntu & distros based off of Ubuntu) for Node.js apps.

Installation

$ npm install node-startup-manager --save

Code example

var startupManager = require('node-startup-manager');

var opts = {
    path: 'C:/Program Files/RealVNC/VNC Server/vncserver.exe', // Path to app - .exe for Windows and .app for OS X
    name: 'My_Awesome_App', // What your app shows up in startup list.
    arguments: ['--dev', '--minimized'] // (optional) Arguments applyed to app on startup (Linux & Windows only for now).
};

startupManager.add(opts)
    .then(function() {
        console.log('App added to startup')
    })
    .catch(function(e) {
        Console.log('Something went wrong; Perms?', e)
    });

startupManager.remove('My_Awesome_App')
    .then(function() {
        console.log('App removed from startup')
    })
    .catch(function(e) {
        Console.log('Something went wrong; Perms?', e)
    });

startupManager.check('My_Awesome_App')
    .then(function(status) {
        console.log('App statup status:', status) // status returned as a boolen
    });

Support

If you're having any problem, please raise an issue on GitHub and I'll be happy to help.

Contribute

License

The project is licensed under the GPL-3.0 license.