Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/marvin-js/marvin
:rocket: Create a workflow (simple or complex) with Marvin.
https://github.com/marvin-js/marvin
automation cli javascript marvin node script workflow
Last synced: 4 months ago
JSON representation
:rocket: Create a workflow (simple or complex) with Marvin.
- Host: GitHub
- URL: https://github.com/marvin-js/marvin
- Owner: marvin-js
- License: mit
- Created: 2018-02-04T19:36:40.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-03-20T17:29:24.000Z (almost 7 years ago)
- Last Synced: 2024-09-23T15:07:17.851Z (5 months ago)
- Topics: automation, cli, javascript, marvin, node, script, workflow
- Language: JavaScript
- Homepage:
- Size: 577 KB
- Stars: 6
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
> Create a workflow (simple or complex) with Marvin.
**The project is still in beta phase.**
# Contents
- [Install](#install)
- [Usage](#usage)
- [CLI Usage](#cli)
- [Philosophy](#philosophy)
- [API Doc](#api-doc)
- [FAQ](#faq)
- [Contributing](#contributing)
## Install
With yarn:
```
yarn add marvin-cli
// or
yarn global add marvin-cli
````
With npm:
```
npm install marvin-cli
// or
npm install marvin-cli --global
```
## Usage
```
// .marvin on project folder
copy /path/oldFile /path/newFile
move /path/earth /path/mars
```
On terminal:
```
$ marvin
```
## CLI
```shellscript
$ marvin --help
Usage: marvin [options] [file ...]
Create a complex workflow in a simpler way
Options:
-v, --version output the version number
-d --dir root directory where files marvins will be search
-h, --help output usage information
Commands:
init create a .marvin.yml. case the command is global, the file will created on $HOME, otherwhise on project root
add add a packet to .marvin.yml
help [cmd] display help for [cmd]
How use the Marvin, step-by-step:
1. : Create um file with name .marvin and these content below
$content = watch ./src/file --async {
log file changed
}
2. : Run the file
marvin
```
## Philosophy
No, is not a new programming language, is only a script, with objective to help create a workflow on day to day. Without panic, of course.
### How is the syntax?
Read [this doc](docs/how-is-syntax.md).
## API Doc
Read [this doc](docs/all-commands.md).
## FAQ
Do you have more doubts? Please, [open a issue](https://github.com/marvin-js/marvin/issues/new) and we will discuss :)
### How create a new plugin?
Please take a look at [this boilerplate](https://github.com/marvin-js/boilerplate-marvin-plugin).
### What is a packet?
Is a package with set of plugins.
### How create a new packet?
Please take a look at [this boilerplate](https://github.com/marvin-js/boilerplate-marvin-packet).
### How add a packet?
```shell
marvin add packet your-packet /path/packet
```
## Contributing
Please read [CONTRIBUTING.md](.github/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
