.tidycode.yml file

With the run:init command you can generate the .tidycode.yml file.

This is an example of a classic .tidycode.yml file

scripts:
  scriptname:
    description: script description
    script:
      - echo "hello world"
      
variables:
  API_PROJECT_NAME: "projectname" #API PROJECT SLUG NAME

remote_scripts:
  dbdump-getfilepath:
    description: a reserved remote script command to get the realpath of a desidered remote backup
    script:
      - realpath db.sql.zip

Scripts (Local)

These are runnable local scripts (line by line) by the run command

Variables

Some projects' variables useful to the cli's features

  • API_PROJECT_NAME the project name to connect via the apis

Remote scripts

Scripts that can be executed to a remote ssh connection, declared in remote_scripts.

remote_scripts:
  get-logs:
    script:
      - tail file.log
Table of Contents