Getting Started

Tidycode's CLI comes for different platforms' support, take a look and find latest cli's releases here to manually get it for your environment.

Installation

Execute this script in a terminal.

Windows (amd64)
Invoke-WebRequest -UseBasicParsing -Uri "https://api.tidycode.it/api/globals/cli/install?platform=windows" -OutFile "./install-tidycode-cli.ps1"; &"./install-tidycode-cli.ps1"
Linux (amd64)
curl -sSL https://api.tidycode.it/api/globals/cli/install?platform=linux |  bash
MacOS (arm64)
curl -sSL https://api.tidycode.it/api/globals/cli/install?platform=darwin |  bash
On Windows This will download and extract the zip of the cli. Once you have the tidycode.exe binary you have to place it in your path to make it available anywhere. See little help here!.
On Linux and MacOS the script will be in $HOME/.tidycode/ but symlinked at /usr/local/bin/tidycode.
On Linux and MacOSsudo,curl and unzip libraries are required; you can install them with apt or your package manager (eg brew on MacOS).
Edit the url to install a specific version or one that satisfies a semantic versionhttps://api.tidycode.it/api/globals/cli/install?platform=windows&version=1.3.x
MacOS is available only since 1.9.3

Initial configuration

Run the init command, this will ensure the $HOME/.tidycode folder exists with an initial config.json file.

tidycode init

After that, run the login command to set your authentication role and get the right permissions to manage Projects.

tidycode login
✨ Well done! Now explore the commands
Table of Contents