In June 2024, we deprecated our old CLI tool (Node based) and released our new CLI tool (Go based). The reasoning was to drastically improve the developer experience for our CLI and for CI integrations.

Migration Steps

1️⃣ Install the new CLI do your build agent:

• The new CLI tool is built in Go, so no more dependency on node/npm needed for build agents

A) Windows (via Powershell):

iwr -useb <https://raw.githubusercontent.com/hathora/ci/main/install.ps1> | iex

B) MacOS/Linux (via bash/zsh):

curl -s <https://raw.githubusercontent.com/hathora/ci/main/install.sh> | sh

C) Download raw binaries

• You can also access the raw binaries here: https://github.com/hathora/ci/releases
  • Both amd64 (x86, etc) and arm64 (Apple M-series, etc) platforms supported for Windows/Linux/Mac
  • use Darwin binaries for MacOS

2️⃣ Update CI build steps with the new command name, hathora (instead of hathora-cloud)

• Note, if you were relying on the cached hathora-cloud login token, you will need to replace that with one of 2 options:
  • Passing a -t flag with each command
  • Setting an environment variable, HATHORA_TOKEN, on your build agents

3️⃣ Update your deploy command flags

The naming and syntax for command flags have changed slightly for consistency and portability.

1. If you were using our old hathora-cloud deploy command, then you will want to update to use hathora deploy

   • Note: You’ll likely want to include the flag --from-latest which was previously default behavior in the old CLI, where the deployment created will default to existing values from the latest deployment version (transport-type, container-port, etc) unless explicitly passed

   • Example deploy command:

     hathora deploy \\
             --file $FILE_OR_DIRECTORY \\
             --build-tag $BUILD_TAG \\
             --rooms-per-process $ROOMS_PER_PROCESS \\
             --container-port $CONTAINER_PORT \\
             --transport-type $TRANSPORT_TYPE \\
             --requested-memory-mb $MEMORY_MB \\
             --requested-cpu $CPU \\
             --env ENV1=$ENV1_VALUE \\
             --env ENV2=$ENV2_VALUE \\
             --idle-timeout-enabled $BOOLEAN\\
             --app-id $APP_ID \\
             --token ${{ secrets.HATHORA_TOKEN }}
     

   • Full docs for deploy flags: https://hathora.dev/docs/hathora-cli#deploy-flags

2. If you were using hathora-cloud build and hathora-cloud deployment previously, then you will want to update to use hathora build create and hathora deployment create

   • Example build create command:

     hathora build create \\
             --file $FILE_OR_DIRECTORY \\
             --build-tag $BUILD_TAG \\
             --app-id $APP_ID \\
             --token ${{ secrets.HATHORA_TOKEN }}
     

     • Full docs for build flags: https://hathora.dev/docs/hathora-cli#build-flags

   • Example deployment create command:

     • Note: You’ll likely want to include the flag --from-latest which was previously default behavior in the old CLI, where the deployment created will default to existing values from the latest deployment version (transport-type, container-port, etc) unless explicitly passed

     hathora deployment create \\
             --build-id $BUILD_ID \\
             --rooms-per-process $ROOMS_PER_PROCESS \\
             --container-port $CONTAINER_PORT \\
             --transport-type $TRANSPORT_TYPE \\
             --requested-memory-mb $MEMORY_MB \\
             --requested-cpu $CPU \\
             --env ENV1=$ENV1_VALUE \\
             --env ENV2=$ENV2_VALUE \\
             --idle-timeout-enabled $BOOLEAN\\
             --app-id $APP_ID \\
             --token ${{ secrets.HATHORA_TOKEN }}
     

     • Full docs for deployment flags: https://hathora.dev/docs/hathora-cli#deployment-flags