Available commands

Tidycode's cli is here to help!

run

Execute a given script by its name available in the .tidycode.yaml, if present.

For example if you have a .tidycode.yaml like this:

scripts:
  example:
    powershell: true
    script:
      - echo 'i am a normal command'

You can execute the example script.

Bash
$tidycode run example$example$RUNNING: echo 'i am a normal command'$i am a normal command
Click to copy

init:tidycode-yaml

This command will create an initial .tidycode.yaml file with an example script.

init

This will ensure there's an initial $HOME/.tidycode/config.json file.

upgrade

Use this command to self-upgrade the cli to the latest version

Use --dry flag to avoid real binary substitution.

Use --to flag to upgrade to a specific or semantic version, the checks are made with semver

install:deploy

This will add/update the .deploy folder for the given framework in your cwd.

This command has i:d as alias

You may see this badge in next commands that requires authentication

login

This will log you in to the Tidycode's API.

This command will store inside the .tidycode/config.json the user information like role, team, and permissions Those information are necessary because each user that use the CLI, could see the projects which are assigned to the same team. Apart from this, those info are mandatory to list only ssh connections which are associated to the user-roles.

This command has api:login and l as aliases

projects

This will list the projects you can have access

This command has api:projects and projects:list as aliases

project

This will show you the data of the current project based on the API_PROJECT_NAME tidycode yaml variable or a project you can give as argument

tidycode project myprj

This command has api:project, api:prj and prj as aliases

ssh

Use this command to access to the ssh remote shell of a project.

CLI will ask you interactively to select a project's connection but you can access it directly via the ssh connection slug.

This command is under restrictions. User can access only to role-env associations.

For example:

A user with role Admin or Sr Developer can access to all connections.

A user with role Jr Developer can only access to a "not-production" ssh connections.

Bash
$tidycode ssh env_slug
Click to copy
Use the API_PROJECT_NAME tidycode yaml variable to ease this process.

This command has ssh:client as alias

ssh:copy

Download/Upload a single file from/to a remote ssh connection

Bash
$tidycode ssh:copy myfile.txt remote:/path/to/file.txt$tidycode ssh:copy remote:/path/to/file.txt myfile.txt
Click to copy
-c or --connection Flag can be used to pass the connection SLUG, avoiding interactions.

This command has scp as alias

Table of Contents