Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zachey01/autostarter
Its a Nodejs module for enabling autostart for your applications!
https://github.com/zachey01/autostarter
automation nodejs npm-module npm-package startup
Last synced: 3 months ago
JSON representation
Its a Nodejs module for enabling autostart for your applications!
- Host: GitHub
- URL: https://github.com/zachey01/autostarter
- Owner: zachey01
- Created: 2024-08-21T19:41:23.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-08-24T13:30:10.000Z (5 months ago)
- Last Synced: 2024-10-02T09:10:41.189Z (4 months ago)
- Topics: automation, nodejs, npm-module, npm-package, startup
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/autostarter
- Size: 8.79 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# `autostarter` 🚀
`autostarter` is a Node.js module that allows you to enable, disable, and check the autostart status of your applications. With `autostarter`, you can easily manage whether your application starts automatically on system boot.
## Table of Contents 📚
- [`autostarter` 🚀](#autostarter-)
- [Table of Contents 📚](#table-of-contents-)
- [Installation 🛠️](#installation-️)
- [npm](#npm)
- [yarn](#yarn)
- [Simple Usage 📝](#simple-usage-)
- [API Documentation 📖](#api-documentation-)
- [`enableAutostart(appName, command, path)`](#enableautostartappname-command-path)
- [`disableAutostart(appName)`](#disableautostartappname)
- [`isAutostartEnabled(appName)`](#isautostartenabledappname)
- [Examples 💡](#examples-)
- [Enable Autostart](#enable-autostart)
- [Disable Autostart](#disable-autostart)
- [Check Autostart Status](#check-autostart-status)
- [Contributing 🤝](#contributing-)
## Installation 🛠️
You can install `autostarter` using either npm or yarn:
### npm
```shell
npm install autostarter
```
### yarn
```shell
yarn add autostarter
```
## Simple Usage 📝
Here's a basic example demonstrating how to use the `autostarter` module:
```js
const autostarter = require("autostarter");
// Enable autostart for an application
autostarter
.enableAutostart("myApp", "node myApp.js", "/path/to/app")
.then(() => console.log("Autostart enabled"))
.catch((error) => console.error("Failed to enable autostart:", error));
// Disable autostart for an application
autostarter
.disableAutostart("myApp")
.then(() => console.log("Autostart disabled"))
.catch((error) => console.error("Failed to disable autostart:", error));
// Check if autostart is enabled
autostarter
.isAutostartEnabled("myApp")
.then((isEnabled) => {
if (isEnabled) {
console.log("Autostart is enabled");
} else {
console.log("Autostart is not enabled");
}
})
.catch((error) => console.error("Failed to check autostart:", error));
```
## API Documentation 📖
### `enableAutostart(appName, command, path)`
Enables autostart for the specified application.
- **Parameters:**
- `appName` (string): The name of the application to be enabled for autostart.
- `command` (string): The command to run the application.
- `path` (string): The path where the application is located.
- **Returns:** `Promise`: Resolves when autostart is successfully enabled.
### `disableAutostart(appName)`
Disables autostart for the specified application.
- **Parameters:**
- `appName` (string): The name of the application to be disabled for autostart.
- **Returns:** `Promise`: Resolves when autostart is successfully disabled.
### `isAutostartEnabled(appName)`
Checks if autostart is enabled for the specified application.
- **Parameters:**
- `appName` (string): The name of the application to check.
- **Returns:** `Promise`: Resolves with `true` if autostart is enabled, `false` otherwise.
## Examples 💡
### Enable Autostart
```js
const autostarter = require("autostarter");
autostarter
.enableAutostart("myApp", "node myApp.js", "/path/to/app")
.then(() => console.log("Autostart successfully enabled for myApp"))
.catch((error) => console.error("Error enabling autostart:", error));
```
### Disable Autostart
```js
const autostarter = require("autostarter");
autostarter
.disableAutostart("myApp")
.then(() => console.log("Autostart successfully disabled for myApp"))
.catch((error) => console.error("Error disabling autostart:", error));
```
### Check Autostart Status
```js
const autostarter = require("autostarter");
autostarter
.isAutostartEnabled("myApp")
.then((isEnabled) => {
if (isEnabled) {
console.log("Autostart is enabled for myApp");
} else {
console.log("Autostart is not enabled for myApp");
}
})
.catch((error) => console.error("Error checking autostart status:", error));
```
## Contributing 🤝
Contributions are welcome! If you have any suggestions, improvements, or bug reports, please submit an issue or pull request on the [GitHub repository](https://github.com/zachey01/autostarter).