Skip to main content

appflow live-update register-artifact


This feature is only available to Enterprise customers with access to Self-hosted Live Updates.

[appflow, live-update, register-artifact]

Bundle and register a Live Update artifact in Appflow

appflow live-update register-artifact [flags]


appflow live-update register-artifact --app-id=12345 --artifact-url= --commit-sha=95f66b50279d54b1f0733e9188fd454768f3fd96 --commit-ref=main [--commit-message=initial]


  • "register"


--app-id [required]stringAppflow app id
--artifact-url [required]stringThe URL to the Self-hosted Live Update Artifact (e.g. '')
--commit-ref [required]stringGit commit ref such as a branch or a tag
--commit-sha [required]stringGit commit SHA
--artifact-typestringThe type of the Live Update Artifact being registered ("zip" / "manifest"), defaults to "zip"
--commit-messagestringCommit message to be displayed in Appflow
--signedbooleanfalseWhether the artifact is signed or not

Global Flags

-h, --helpbooleanfalsePrint help information for command
--configstringAppflow config file (.appflow.yaml by default)
--jsonbooleanfalseFor commands with output, shortcut to print as JSON
--outputstring"text"For commands with output, print as [json] or human readable [text]
--tokenstringIonic authorization token


appIdstringYour app's unique identifier in Appflow.
artifactURLstringThe self-hosted URL to be used to retrieve a Live Update.
buildIdnumberA unique identifier for a build done in Appflow.
buildNumbernumberAn app-specific build number for builds done in Appflow.
commitShastringThe commit hash.
commitRefstringThe branch a commit was made on.
commitMessage (optional)stringThe message that was provided when a commit was made.
Successful Output
"appId": "052b32ac",
"artifactURL": "",
"buildId": 6010455,
"buildNumber": 25,
"commitSha": "cef1sdca",
"commitRef": "main",
"commitMessage": "feat: enable customer delight"
Failed Output
"appId": "052b32ac",
"artifactURL": "",
"buildId": 0,
"buildNumber": 0,
"commitSha": "cef1sdca",
"commitRef": "main",
"commitMessage": "feat: enable customer delight"