Install appcfg

Prev Next

This document provides instructions for installing, configuring, and initializing the appcfg command-line interface (CLI) for managing Gladly applications.

Linux / Windows Susbystem for Linux Installation

Download the latest version of appcfg for your architecture and OS from https://github.com/gladly/app-platform-appcfg-cli/releases/latest

unzip the downloaded file, and move it to ~/.local/bin:
mv appcfg-<version>-linux-intel -r ~/.local/bin

for convenience, add an alias for appcfg:
echo 'alias appcfg=~/.local/bin/appcfg' >> ~/.bashrc

reload your .bashrc to pick up the alias:
source ~/.bashrc

test that you are able to execute appcfg:
appcfg --version

Windows Installation

Download the latest version of appcfg for your architecture and OS from https://github.com/gladly/app-platform-appcfg-cli/releases/latest

Install PowerShell if it is not already installed. PowerShell is required for autocompletion in appcfg under Windows. If you are unfamiliar with PowerShell, or run into issues with your profile, this documentation is a good reference.

In PowerShell, create a directory for appcfg:
mkdir ~/.local/bin

Unzip the appcfg download to ~/.local/bin:
Expand-Archive -Path "~\Downloads\appcfg-4.1.1-win.zip" -DestinationPath "~\.local\bin"

For convenience, create an alias for appcfg:
Test-Path $PROFILE
if FALSE is returned, create a profile file using:
New-Item -ItemType File -Path $PROFILE -Force

open the profile file in notepad:
notepad $PROFILE

add the following to set the alias:
Set-Alias -Name appcfg ~\.local\bin\appcfg

save your changes in notepad; reload your profile to apply the alias:
. $PROFILE

Test the alias by getting the appcfg version:
appcfg --version

macOS Installation

Download the latest version of appcfg for your architecture and OS from https://github.com/gladly/app-platform-appcfg-cli/releases/latest

Unzip appcfg:
cd ~/Downloads
tar -xzvf appcfg-<version>-mac-apple.zip

Move appcfg to a directory, and make it executable:
mv appcfg ~/.local/bin/
chmod a+x appcfg

For convenience, create an alias for appcfg:
echo 'alias appcfg=~/.local/bin/appcfg' >> ~/.zshrc

Test the alias by getting the appcfg version:
appcfg --version

Mac Users

Due to macOS security settings (Gatekeeper), you may need to explicitly allow appcfg to run the first time.
If you get a modal similar to:
image.png
In Mac OS, go to System Settings > Privacy & Security > Approve external app in the settings:
image.png
After you approve the app, rerun appcfg --version to verify the installation.