Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pedrofnseca/automation-scripts-cli
✨ Automate tasks effortlessly via terminal scripts. Save time and boost productivity!
https://github.com/pedrofnseca/automation-scripts-cli
automation cli manager-system nodejs
Last synced: 5 days ago
JSON representation
✨ Automate tasks effortlessly via terminal scripts. Save time and boost productivity!
- Host: GitHub
- URL: https://github.com/pedrofnseca/automation-scripts-cli
- Owner: PedroFnseca
- Created: 2023-08-18T23:30:22.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-08-19T21:50:19.000Z (about 1 year ago)
- Last Synced: 2024-10-10T09:54:59.080Z (about 1 month ago)
- Topics: automation, cli, manager-system, nodejs
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/automation-scripts-cli
- Size: 9.77 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Automation-script-cli
### The Automation-script-cli is a powerful command-line tool designed to simplify task automation using terminal scripts. It allows users to define custom commands in a JSON configuration file, making it easy to execute complex operations with a single command.
---
## Getting Started
### Installation
```bash
npm install -g automation-scripts-cli
```
### Upload configuration file
```bash
automation-scripts-cli --upload
```
### Execute command
```bash
automation-scripts-cli --command-name
```
## Example configuration
> The configuration file must be a JSON file with the following structure:
```json
[
{
"name": "example",
"description": "Description of the example",
"options": [
{
"name": "--verbose",
"alias": "-v",
"description": "Activate verbose mode"
},
{
"name": "--output",
"alias": "-o",
"description": "Specify the output file",
"required": true
}
],
"exec": [
"echo 'Executing the example command'",
"node script.js example"
]
}
]
```
| Field | Type | Value |
| ------------- | --------------- | --------------------------------------- |
| `name` | String | example |
| `description` | String | Description of the example |
| `options` | Array -> object | |
| | String | 1. `name` --verbose |
| | String | - `alias` -v |
| | String | - `description` Activate verbose mode |
| | String | 2. `name` --output |
| | String | - `alias` -o |
| | String | - `description` Specify the output file |
| | Boolean | - `required` true |
| `exec` | Array -> String | |
| | String | 1. echo 'Executing the example command' |
| | String | 2. node script.js example |
## More examples of configuration files
> in this repository: [examples](./examples/) have more examples of configuration files
- [x] [backup](./examples/backup.json) - Backup files and folders
- [x] [start development](./examples/start-development.json) - Start development environment