2. Installation and upgrade

Prerequisites

The following software needs to be installed on your computer before you can install Taito CLI.

• Bash (already included on Linux and macOS)
• Git
• Docker

Additional details

Linux: See Docker Post-installation steps for Linux.

Windows: It is recommended to use Docker Desktop WSL 2 backend. Make sure you follow the best practices mentioned in the docker installation instructions. That is, source code should be located on Linux disk. You can use Visual Studio Code Remote - WSL to modify the source code remotely from Windows. If you are using some other editor than VS Code, you can use some other sync mechanism to copy changed files from Windows to Linux (e.g. Cygwin rsync, cwRsync)

If you cannot use Docker Desktop WSL 2 backend on Windows, you can try some bash emulation instead (e.g. Git Bash). However, docker-for-win#1588 may cause you some trouble. You can also try to run Docker inside a Linux virtual machine.

Automatic installation

1. Install Taito CLI by running the following command on your unix-like shell (e.g. bash or zsh). The git clone method is either https or ssh:

   export TAITO_INSTALL_DIR=~/.taito-cli && \
   export TAITO_GIT_CLONE_METHOD=ssh && \
   curl -fsSL https://raw.githubusercontent.com/TaitoUnited/taito-cli/master/install.sh | bash
   

2. The install script adds Taito CLI on your PATH by modifying your shell startup files (~/.bashrc, ~/.bash_profile, ~/.zshrc). Restart your shell or open a new terminal so that the taito command becomes available.

3. Execute the final installation steps:

   taito upgrade
   

4. Check the installation:

   taito check
   

5. Show the available taito commands:

   taito -h
   

If you have problems, run taito trouble to display troubleshooting. You can read the troubleshooting instructions also at GitHub.

Manual installation

See the install.sh script and execute the steps manually in any way you like.

Upgrade

You can upgrade Taito CLI and its extensions anytime by running taito upgrade.

---

Next: 3. Quick start