Migrate from extend-helper-cli
Overview
The Extend Helper CLI is deprecated. Use the AGS CLI ags extend commands for current Extend work. The end-of-support date is on the Extend Helper CLI page. Working examples are on AGS CLI for Extend.
Sign in
See Install and sign in for browser login and client-credentials login.
The extend-helper-cli login, logout, and status commands are now ags auth login, ags auth logout, and ags auth status. You sign in once per session instead of passing credentials to each command.
The AGS CLI reads AGS_BASE_URL, AGS_CLIENT_ID, AGS_CLIENT_SECRET, and AGS_ACCESS_TOKEN. It does not read AB_BASE_URL, AB_CLIENT_ID, or AB_CLIENT_SECRET.
Command mapping
| extend-helper-cli | AGS CLI |
|---|---|
extend-helper-cli create-app --scenario service-extension --confirm | ags extend create-app --json '{"scenario":"service-extension"}' --yes |
extend-helper-cli get-app-info | ags extend get-app-info |
extend-helper-cli get-app-info --path <field> | ags extend get-app-info --format json |
extend-helper-cli list-images | ags extend list-images |
extend-helper-cli deploy-app --image-tag v1.0.0 | ags extend deploy-app --json '{"imageTag":"v1.0.0"}' |
extend-helper-cli start-app / stop-app | ags extend start-app / ags extend stop-app |
extend-helper-cli delete-app --confirm | ags extend delete-app --yes |
extend-helper-cli dockerlogin | ags extend docker-login |
extend-helper-cli image-upload | ags extend image-upload |
extend-helper-cli tunnel | ags extend database-tunnel |
extend-helper-cli update-var / update-secret | ags extend update-var / ags extend update-secret |
extend-helper-cli clone-template --scenario "Extend App UI" --template <name> | ags extend clone-template --template "Extend App UI :: <name> :: JavaScript" |
extend-helper-cli appui create --name <name> | ags extend app-ui create --json '{"name":"<name>"}' |
extend-helper-cli appui setup-env --name <name> | ags extend app-ui setup-env --name <name> |
extend-helper-cli appui upload --name <name> | ags extend app-ui upload --name <name> |
extend-helper-cli remote-debug enable --confirm | ags extend remote-debug enable --yes |
extend-helper-cli logs stream | ags extend logs stream |
--namespace is still the flag that selects the game namespace. --confirm is now --yes.
database-tunnel requires AGS CLI 0.5.3 or later. logs stream requires AGS CLI 0.5.2 or later.
dockerlogin and appui are not accepted as aliases.
Database tunnel
extend-helper-cli tunnel is ags extend database-tunnel in AGS CLI 0.5.3 and later. On 0.5.2 the command is ags extend tunnel. It opens a local TCP port to an Extend database: NoSQL, SQL, or Key Value Store. In 0.5.3, ags extend tunnel still runs this command and stays hidden from ags extend --help. It will be removed in a later release, so use ags extend database-tunnel in scripts.
ags extend database-tunnel --resource-name <resource-name> --namespace <namespace> --local-port <port>
-r is short for --resource-name, and -p is short for --local-port. This command has no --pod-name. To reach one app pod for debugging, use ags extend remote-debug connect.
Docker login on Windows
Docker Desktop on Windows stores registry credentials through a credential helper. The token that the Extend registry issues is about 2,924 bytes, which exceeds the 2,560-byte limit of the Windows Credential Manager, so ags extend docker-login and ags extend image-upload --login both fail on native Windows. Use the --print and --print-format token options to print the token and pass it to docker login yourself:
ags extend docker-login --namespace <namespace> --app <app> --print --print-format token \
| docker login --username <username> --password-stdin <registry>
For other Docker registry problems, see Docker login fails on the AGS CLI for Extend page.
What else changed
ags extend database-tunnelandags extend remote-debug connectreport session events while they run. Each event line includes the time elapsed since the command started, so you can confirm a long session is still active.ags extend remote-debug disableasks for confirmation before it restarts a running app. Pass--yesto skip the prompt in automation.- Commands that return a result accept
--format jsonfor machine-readable output.ags extend database-tunnelwrites session events to stderr, and--format jsonswitches those events to JSON.--no-inputdisables interactive prompts, for use in scripts and CI.