Migrate from extend-helper-cli
Overview
The extend-helper-cli continues to work. The AGS CLI covers all extend-helper-cli Service commands today and adds canonical addresses at ags csm. Each command listed below also works at its ags extend shortcut address during the migration window.
Sign in
See Install and sign in for the two login modes.
The extend-helper-cli login, logout, and status commands are superseded by ags auth login, ags auth logout, and ags auth status. You sign in once per session instead of passing credentials to each command.
Command mapping
| extend-helper-cli | AGS CLI (canonical) | AGS CLI (shortcut) |
|---|---|---|
extend-helper-cli create-app | ags csm apps create | ags extend create-app |
extend-helper-cli get-app-info | ags csm apps get | ags extend get-app-info |
extend-helper-cli list-images | ags csm images list | ags extend list-images |
extend-helper-cli deploy-app | ags csm deployments create | ags extend deploy-app |
extend-helper-cli start-app | ags csm apps start | ags extend start-app |
extend-helper-cli stop-app | ags csm apps stop | ags extend stop-app |
extend-helper-cli delete-app | ags csm apps delete | ags extend delete-app |
extend-helper-cli remote-debug enable | ags csm debug update | ags extend remote-debug enable |
extend-helper-cli remote-debug disable | ags csm debug update | ags extend remote-debug disable |
extend-helper-cli appui create | ags csm app-ui create | ags extend app-ui create |
Use the canonical ags csm address for new scripts. The ags extend shortcuts exist to smooth the transition and follow the same invocation shape as extend-helper-cli.
The remote-debug enable and remote-debug disable shortcuts prompt you to confirm before acting. They read app status first and pause if the app is not in the expected state. The legacy tool did not do this.
Commands already available under ags extend
These commands work at the same address in the AGS CLI with no changes:
ags extend clone-templateags extend docker-loginags extend image-uploadags extend tunnelags extend update-varags extend update-secretags extend app-ui uploadandags extend app-ui setup-envags 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 in the extend-helper-cli guide; the causes and fixes there apply to the AGS CLI as well.
What else changed
ags extend 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.- Every command accepts
--format jsonfor machine-readable output and--no-inputto disable interactive prompts, for use in scripts and CI.