npm

funky-cat

1.0.6-pre • Public • Published

funky-cat

Contents

Introduction

funky-cat is the CI/CD tool for local development. Run any cli tools installed on your machine sequentially.

Installation

  • Install using Yarn:
yarn global add funky-cat
  • Install using NPM:
npm install -g funky-cat

Action Schema

<action_name>:
    workingDir: <direcotry>
    commands:
        - <command 1>
        - <command 2>
  • action_name : Unique name for each action.

  • workingDir : Relative path/directory where the current cli tool is running on.

  • commands : Set of cli commands to be executed for the defined action.

Setup a local job

  • Create funky-compose.yml file in the root directory of the project and define the actions:

    hello_world:
        commands:
            - echo hello world
     
    custom_action:
        workingDir : app
        commands:
            - yarn install
            - yarn build
  • Run the action : funky-cat run <action>

    funky-cat run hello_world
  • Run multiple actions : funky-cat run|r [options] [actions...]

    funky-cat run hello_world custom_action
  • Create a new action which runs combined action.

    combined_action:
        commands:
            - funky-cat run hello_world custom_action
     
    hello_world:
        commands:
            - echo hello world
     
    custom_action:
        workingDir : app
        commands:
            - yarn install
            - yarn build
  • Run the combined action.

    funky-cat run combined_action

Templates

funky-cat comes with a set of templates to bootstrap your project. To bootstrap a project from available templates, Run :

funky-cat new

This will start a prompt to select the available templates.

or

funky-cat new <template_name>

Or, if you know the template name already, pass it as <template_name> along with funky-cat new command to skip the prompt.

Flags

  • ### Run -c | --config : Specify the compose file. By default funky-cat uses funky-compose.yml in root directory.

      funky-cat run -c my_compose_file.yml [actions...]
    

License

  • MIT

Package Sidebar

Install

npm i funky-cat

Weekly Downloads

2

Version

1.0.6-pre

License

MIT

Unpacked Size

331 kB

Total Files

37

Last publish

Collaborators

  • iamvishnusankar