Why | Config | Installation | Usage | Options

Why?

Internal processes can get complicated or too repetitive

The main goal of the mxflow project is to streamline and simplify complex processes

Major features:

• Interactive first
• Local first
• Extensive config
• Shell completion

a CICD for internal processes and workflows on local machines for teams

group commands under a workflow, write steps, use special commands like confirm

💥 Unopinionated config based workflow engine

🗃️ Streamline complex workflows across teams

💡 Simplify complex commands

Special command prefix

• confirm {command} adds a confirmation step to any commands

Config order

• ./.mxflow/config.yml
• ~/.mxflow/config.yml

version: 0.60.0
sleep: 1000
workflows:
  feature:
    description: feature example workflow
    args:
      - name: taskId
        type: string
        export: taskId
      - name: description
        type: string
        export: description
      - name: MXF_BUG_TRACKER_NAME
        type: env
        default: jira
        export: bugTrackerName
      - name: MXF_BUG_TRACKER_TENANT
        type: env
        default: metaory
        export: bugTrackerTenant
    steps:
      - git fetch origin
      - git checkout master
      - git merge origin/master
      - checkout-branch:
          base: flight
      - git checkout -b {workflow}/{taskId}-{description}
      - git status
      - confirm git push --set-upstream origin
        {workflow}/{taskId}-{description}
      - list-logs:
          limit: 100
      - log-bugtracker:
          bugtracker: "{bugTrackerName}"
          tenant: "{bugTrackerTenant}"

sample usecase: git-workflow

Arg Types

• string
• number
• env

Requirements

• Node 16.x

Installation

npm i -g mxflow
mxflow --setup-completion

or

npx mxflow
npx mxflow --setup-completion

Usage

mxflow # or mxf
mxflow trigger foobar --verbose
mxflow trigger feature --taskId xorg --description zelda
mxflow --no-catch-git # to bypass initial git checks

Options

init                    | init sample configuration
trigger <workflow-name> | non-interactive workflow trigger
verbose                 | verbose logs
version                 | show version
--help                  | help menu
--no-catch-git          | bypass initial git checks
--setup-completion      | setup tab completion, your shell
--clean-completion      | cleanup tab completion

Roadmap

• project based config file
• plugin system for dynamic lists
• aurgument mode
• argument autocomplete

⚠️ MXFlow is in an early state of release. Breaking changes may be made to APIs/core structures as the tool matures.