vinm-cli

Tiny CLI that help developers create robust execution pipelines.

Usage no npm install needed!

<script type="module">
  import vinmCli from 'https://cdn.skypack.dev/vinm-cli';
</script>

README

VÄ«nm CLI

pipeline status

Tiny CLI that help developers create robust execution pipelines.

It can be challenging to deploy microservices architectures at scale, even more, if you like to create decoupled infrastructures as code. Vinm is a tiny CLI that help developers create robust execution pipelines and reduce software deployment anxiety.

Few things Vinm can help with:

  • Build and deploy a fleet of services via a single command.
  • Easily manage infrastructure as code for decoupled architectures.
  • Orchestrate deployments for Serverless, AWS CDK and more.

📦 CLI installation

# With npm
npm i -g vinm-cli

# OR With yarn
yarn global add vinm-cli

⚙️ Project setup

Create a vinm.yml file at the root of your project.

Sample:

project: hello-world

stages:
    staging:
        message: world

tasks:
    hello:
        description: Say "hello"
        shell: >-
            echo "hello"
    world:
        description: Say "world"
        shell: >-
            echo "$vinm.message"

pipelines:
    helloWorld:
        - task: hello
        - task: world

🚀 CLI usage

Usage
    $ vinm <pipeline> <options>
    $ vinm @<task> <options>

Options
    --stage, -s     Stage vars to use    # optional
    --force, -f     Force run all tasks  # optional
    --help, -h      Show help            # optional
    --version, -v   Current version      # optional 

Examples
    $ vinm deploy                        # run 'deploy' pipeline
    $ vinm @api-create                   # run 'api-create' task

Sample:

vinm helloworld

🤝 Contributing

Contributions, issues and feature requests are welcome on the Gitlab repository.

📝 License

Copyright © 2020 maoosi.
This project is MIT licensed.