Skip to content

Latest commit

 

History

History
85 lines (73 loc) · 1.86 KB

readme.md

File metadata and controls

85 lines (73 loc) · 1.86 KB
Raw

Installation

npm i -g nyatictl

Running tasks

- without specifying configuration file
nyatictl <host>

- specifying configuration file
nyatictl --conf nyati.yaml <host>

Options

options:
        nyatictl <host>  ; single host
        nyatictl all     ; all hosts
        nyatictl <host>  ; single host
        --task                    ; run single task
        --debug                   ; print debug information

Task definition

 name: task name no spaces
 cmd: task action
 expect: expected action code
 message: on success message
 output: print on success stdout
 dir: working dir
 lib: available through --task flag
 retry: ask to retry on fail
 askpass: password will be asked if required, useful for commands that require sudo

Configuration

version: 0.1.3      # version lock
appname:
dir: '/var/www/html/${appname}/'
params:
  myparam: this is my paramater value
hosts:
  live:
    host: localhost
    username: ''
    privateKey: ''
    port: ''
    password: '#env:THIS_IS_ENV_KEY'   //this value will be loaded from .env on  the current directory (#env:)
    privateKey: '/home/<username>/.ssh/id_rsa' //this can also be configured on .env file
    passphrase: '#env?:THIS_IS_ENV_KEY'   //optional enviroment value, no error when not found (#env?:)
  test:
    host: ''
    username: ''
tasks:
  - name: create file
    cmd: touch ~/test.hi
    expect: 0
    retry: 1
  - name: write to file
    cmd: echo HelloWorld > ~/test.hi
    expect: 0
  - name: write param to file
    cmd: echo ${myparam} > ~/test.hi
    expect: 0
    message: This message will be printed when this task is completed with expect code
  - name: test sudo
    cmd: echo HelloWorld > /test.hi
    expect: 0
    askpass: 1

Default paramaters

appname           ; value from config file
release_version   ; current unix timestamp in milliseconds