Skip to main content

Installation

You can install the latest version - , by using NPM.

NPM

  1. If you don't already have nodejs installed, you can find the instructions here.

  2. Install Tailcall by running the following command in your terminal:

    npm i -g @tailcallhq/tailcall
  3. To verify the correct installation of Tailcall, run:

    tailcall
    note

    Do not use the --force flag during npm installations, as it ignores installing platform-specific builds.

Yarn

  1. Install Tailcall by running the following command in your terminal:

    yarn global add @tailcallhq/tailcall
  2. To verify the correct installation of Tailcall, run:

    tailcall

Homebrew

  1. If you don't already have Homebrew installed, you can find the instructions here.

  2. Add the Tailcall repository to Homebrew by running the following command in your terminal:

    brew tap tailcallhq/tailcall
    brew install tailcall
  3. To verify the correct installation of Tailcall, run:

    tailcall
  4. After completing the installation, perform upgrades with:

    brew update
    brew upgrade tailcall

Curl

Follow the steps below to manually install the cli on your system:

curl -sSL https://raw.githubusercontent.com/tailcallhq/tailcall/master/install.sh | bash -s -- 

This command fetches and executes the Tailcall installation script. The ~/.tailcall directory contains the installed files.

Upon completion of the installation, extend your PATH environment variable to include the ~/.tailcall/bin directory:

export PATH=$PATH:~/.tailcall/bin

Docker

To install Tailcall with Docker, follow the steps below. Before starting, make sure you have Docker installed on your system. If not, download it from here.

  1. Pull the latest Tailcall Docker image using the following command:

    docker pull tailcall.docker.scarf.sh/tailcallhq/tailcall/tc-server:

    This command fetches the latest version of the Tailcall Docker image from the Docker registry.

  2. Run the Tailcall Docker container with the following command:

    docker run -p 8080:8080 -p 8081:8081 tailcall.docker.scarf.sh/tailcallhq/tailcall/tc-server:

    This command launches the Tailcall server in a Docker container, exposing the GraphQL endpoint on port 8080.