Docs
Upload builds from CI
Every build your pipeline makes can land on AppForShare with release notes, and your testers get the link right away. The store readiness result comes back too, so a build that would be rejected can stop the pipeline. Uploads from CI are part of Pro and Team. Create a token under Dashboard, Settings. Calling the API yourself? See the CI API reference. Coming from Firebase App Distribution? Follow the step by step move. Coming from Diawi? See move from Diawi. Coming from InstallOnAir? See move from InstallOnAir. Coming from AppsOnAir? See move from AppsOnAir. Coming from Loadly? See move from Loadly. Moving testers off Bitrise Release Management while keeping Bitrise CI? See move from Bitrise. Building on Expo EAS? See use with Expo EAS. Building on Codemagic? See use with Codemagic. Coming from Zunoy AppShare or ShareIPA? See move from Zunoy AppShare. Coming from BetaDrop? See move from BetaDrop. Coming from Updraft? See move from Updraft. Failing a pipeline on the security scan? See security scan. Reading the malware check status from CI? See malware check.
Any CI or your terminal
Needs Node 18 or newer. The command prints the install link.
export APPFORSHARE_TOKEN=afs_your_token
npx appforshare upload build/MyApp.ipa --notes "Fixes the login crash"Flutter and React Native: both platforms in one command
Run init once in the repo: it finds where your iOS and Android builds land (Flutter, React Native and native projects) and writes appforshare.config.json with those folders and an optional channel. Commit it. Then upload with no file sends the newest .ipa and the newest .apk or .aab, each with its own notes if you like. upload also takes a folder and sends the newest build in it. In GitHub Actions leave file empty (or give a folder) and read ios-url and android-url. CLI 1.11.0.
npx appforshare init --channel beta
npx appforshare upload --ios-notes "New checkout" --android-notes "New checkout, Android 15 fix"
npx appforshare upload build/app/outputs/flutter-apkGitHub Actions
Store the token as a repository secret named APPFORSHARE_TOKEN. The step outputs url, slug and readiness.
- name: Share build
id: afs
uses: appforshare/appforshare-action@v1
with:
file: app/build/outputs/apk/release/app-release.apk
token: ${{ secrets.APPFORSHARE_TOKEN }}
release-notes: ${{ github.event.head_commit.message }}
fail-on: blocked
- run: echo "Install link: ${{ steps.afs.outputs.url }}"Install links on the pull request
With pr-comment: true the GitHub Action keeps one comment on the pull request with the iOS and Android install links, their QR codes, the store readiness result and the channel, and updates it on each run, so reviewers install the change from the pull request. An iOS job and an Android job fill the same comment. It uses the workflow token: give the job pull-requests: write. On push and manual runs it comments on the open pull request of the branch. Pull requests from forks get a read only token, so nothing is posted there. A problem with the comment is a warning and never fails the upload. In other steps, npx appforshare upload --pr-comment does the same with GITHUB_TOKEN in the environment. Pro and Team. CLI 1.19.0.
on: pull_request
jobs:
android:
runs-on: ubuntu-latest
permissions:
contents: read
pull-requests: write
steps:
# ... build the app ...
- uses: appforshare/appforshare-action@v1
with:
file: app/build/outputs/apk/release/app-release.apk
token: ${{ secrets.APPFORSHARE_TOKEN }}
pr-comment: trueGitLab CI
Add APPFORSHARE_TOKEN as a masked CI/CD variable.
share:
image: node:22
script:
- npx --yes appforshare upload build/MyApp.ipa --json > appforshare.json
artifacts:
paths: [appforshare.json]Fastlane
Add the plugin once with fastlane add_plugin appforshare. Without file it takes the build from gym or gradle.
lane :beta do
gym(export_method: "ad-hoc")
appforshare(release_notes: "Fixes the login crash", fail_on: "blocked")
puts lane_context[SharedValues::APPFORSHARE_URL]
endBeta and Live channels
A channel has one link and QR code that never change and always open the newest build put into it. The channel is created the first time you use its name. The GitHub Action takes channel and outputs channel-url; Fastlane takes channel: and sets APPFORSHARE_CHANNEL_URL. On Team a release checklist can guard Live: promote then answers with what is missing (checklist shows it), and an Admin token may add --force. If your iPhone testers use TestFlight, give the channel its public link: iPhones then go to TestFlight and Android phones get the APK (off removes it). Pro and Team.
npx appforshare upload app-release.apk --channel beta
npx appforshare latest --channel beta
npx appforshare promote 12345 --channel live
npx appforshare checklist 12345
npx appforshare release status 2.4.0 --app com.example.app
npx appforshare testflight https://testflight.apple.com/join/AbCd1234 --channel beta --app com.example.appEmail the link, password and who installed
--email sends the install link to up to 5 addresses when the build is ready: one plain mail per build and address, up to 50 addresses a day per account, not for projects open only to invited testers (Pro and Team). email does the same for a build that is already uploaded. --password protects the link (4 to 128 characters). --comment is the same as --notes, as on Diawi. installs lists who installed a build, with device, OS, country and the tester when known. channel-address gives a channel its own address such as /c/acme-beta; the old one redirects for 30 days (Pro and Team). The GitHub Action takes email and password inputs; fastlane takes email: and password:. CLI 1.10.0.
npx appforshare upload MyApp.ipa --email [email protected],[email protected] --password "$LINK_PASSWORD" --comment "Fixes the login crash"
npx appforshare email Stw0Ae --to [email protected]
npx appforshare installs Stw0Ae
npx appforshare channel-address acme-beta --channel beta --app com.example.shop
# GitHub Actions
- uses: appforshare/appforshare-action@v1
with:
file: build/MyApp.ipa
token: ${{ secrets.APPFORSHARE_TOKEN }}
email: [email protected],[email protected]
password: ${{ secrets.LINK_PASSWORD }}
# fastlane
appforshare(email: ["[email protected]", "[email protected]"], password: ENV["LINK_PASSWORD"])Scripts written for Diawi
A script that calls the Diawi upload API works here after you change the URL and the token: same multipart fields (token, file, password, comment, callback_url, callback_emails) and the same status codes. One request carries up to 100 MB; bigger builds go through the CLI, which uploads in parts. Pro and Team.
curl https://appforshare.io/api/ci/diawi -F token=$APPFORSHARE_TOKEN -F [email protected] -F comment="Fixes the login crash"
curl "https://appforshare.io/api/ci/diawi/status?token=$APPFORSHARE_TOKEN&job=<job>"Scripts written for Pgyer or Loadly
A script or plugin that calls the Pgyer API v2 (Loadly uses the same API) works here after you change the base URL to https://appforshare.io/api/ci/pgyer and put an AppForShare token in _api_key. app/upload, getCOSToken with buildInfo, and app/check answer in Pgyer's shape; password, release notes, end date and channel fields are mapped, the rest is ignored and listed in the answer. Up to 100 MB per request. Pro and Team.
curl https://appforshare.io/api/ci/pgyer/apiv2/app/upload -F _api_key=$APPFORSHARE_TOKEN -F [email protected] -F buildUpdateDescription="Fixes the login crash"Jenkins and Bitrise
A Jenkins plugin (a pipeline step with the token in a Secret text credential) and a Bitrise step are coming. Until they are published, run the CLI in a shell step, as the Jenkins and Bitrise guides show.
// Jenkinsfile
withCredentials([string(credentialsId: 'appforshare-token', variable: 'APPFORSHARE_TOKEN')]) {
sh 'npx --yes appforshare upload build/MyApp.ipa --channel beta --fail-on blocked'
}
# Bitrise Script step (APPFORSHARE_TOKEN as a Secret)
npx --yes appforshare upload "$BITRISE_IPA_PATH" --channel betaShare with testers and groups (Team)
Name tester groups and people when you upload, the way Firebase's --groups and --testers work. When the build is ready the groups get its project, new addresses become testers, and everyone named gets the new build email even when the project's notices are off, at most one per tester per project in an hour. distribute does the same for a build that is already uploaded. testers and groups manage the lists; import reads a CSV with email, name and groups columns (up to 1,000 rows, invites off unless you add --notify). CLI 1.9.0. Coming from Bitrise Release Management? import bitrise copies its tester groups and testers: the CLI reads Bitrise with your Bitrise personal access token (--bitrise-token or BITRISE_TOKEN) on your computer and sends AppForShare only the names and emails, never the token. Without --app it lists your Bitrise apps; --app takes the connected app id or the bundle id. Groups are matched by name or made, --dry-run only counts, and no invites go out unless you add --notify (CLI 1.18.0). The GitHub Action gets groups and testers inputs in its next release.
npx appforshare upload app-release.apk --groups "Client QA,Internal" --testers [email protected]
npx appforshare upload MyApp.ipa --testers-file testers.txt
npx appforshare distribute 12345 --groups "Client QA"
npx appforshare testers --group "Client QA"
npx appforshare testers add [email protected],[email protected] --project 42 --groups "Client QA"
npx appforshare testers import testers.csv --groups Beta
npx appforshare import bitrise
npx appforshare import bitrise --app <Bitrise connected app id> --dry-run
npx appforshare import bitrise --app com.acme.notes --groups "QA Team"
npx appforshare testers remove [email protected] --project 42
npx appforshare groups add "Client QA" --project 42
npx appforshare groups add-members "Client QA" [email protected]
npx appforshare groups delete "Old group" --yesExpo builds (EAS Build)
upload --eas <build id> runs eas build:view --json on the same machine, downloads the build Expo made and uploads it with release notes from the build message or commit; upload --eas-latest takes the newest finished build of a profile (--profile, else the one init saved from eas.json) for each platform, or one with --platform. Your Expo sign in never leaves the machine. Store and simulator builds are refused, as they cannot install from a link. eas connect turns on Connect Expo for a project: a webhook address and secret, and the eas webhook:create command to run once, after which Expo sends every finished internal build on its own (Pro and Team). CLI 1.19.0. Guide: /docs/ci/expo-eas.
npx appforshare init # in an Expo project: reads eas.json profiles
npx appforshare upload --eas 147a3212-49fd-446f-b4e3-a6519acf264a --channel beta
npx appforshare upload --eas-latest --profile preview --platform android
npx appforshare eas connect --project 42 --profile preview=Beta
npx appforshare eas status --project 42Release defaults and scheduled Play rollouts
release-defaults saves What's New per language, App Store phased release and the Google Play track and rollout for an app; the dashboard forms fill them in and nothing is sent to a store from them (Pro and Team). play rollout-plan raises a Google Play production rollout that is already in progress at set times: each step is a percent and the wait after the step before. Before every step AppForShare reads Google Play and halts the plan, without a change, if the rollout was halted or changed anywhere else; the owner gets an email at each step. Anyone can pause or stop a plan; setting and resuming one needs an Admin (Team). CLI 1.16.0.
npx appforshare release-defaults com.acme.notes --lang en-US --notes "Bug fixes and faster sync"
npx appforshare release-defaults com.acme.notes --track production --rollout 5
npx appforshare release-defaults io.acme.ios --phased on
npx appforshare play rollout-plan com.acme.notes --steps 10@1d,50@2d,100@2d --yes
npx appforshare play rollout-plan com.acme.notes pauseSend a build to TestFlight or Google Play
store-upload sends a build you uploaded to its store with your connected App Store Connect key or Google Play service account: an App Store signed .ipa goes to App Store Connect, and Apple processes it for TestFlight; an .aab uploaded on Pro or Team is kept and goes to a Google Play testing track. play:production makes a draft you roll out in Play Console (Team). Needs an Admin and --yes every time; --watch waits for the result. Without --to it shows whether the build can go and every send so far (Pro and Team). CLI 1.19.0.
npx appforshare store-upload 12345 --to testflight --yes --watch
npx appforshare store-upload 12346 --to play:internal --yes
npx appforshare store-upload 12346Store send options, and sending right after the upload
TestFlight: --what-to-test sets What to Test once Apple has processed the build (add --lang de-DE for one language; without it, every language the build has). On Team, --groups "QA,Clients" gives the processed build to those TestFlight groups, internal or external, and --beta-review submits it for TestFlight beta review; you get an email with the result, and --list-groups shows the groups of the app. Google Play: --release-name, --update-priority 0 to 5, and --not-for-review when Google asks for the changes to be sent by hand. upload --store-upload testflight or play:<track> with --yes queues the send right after the upload in the same step (an Admin's token; TestFlight groups there are --testflight-groups). CLI 1.20.0.
npx appforshare store-upload 12345 --to testflight --what-to-test "Check the new login" --groups "QA,Clients" --beta-review --yes
npx appforshare store-upload 12346 --to play:internal --update-priority 3 --release-name "2.4.0 (51)" --yes
npx appforshare upload build/app.ipa --store-upload testflight --what-to-test "$(git log -1 --pretty=%B)" --yesDevices and test plans
devices import reads Firebase's Export Apple UDIDs file, Apple's Register Multiple Devices file, one UDID per line or the output of eas device:list --json (up to 1,000 per import; - reads stdin, CLI 1.19.0). devices export writes your devices in Apple's format, for the Apple portal or fastlane register_devices. test-plan downloads the AI test plan of a build as Firebase App Testing agent YAML (Android only, in preview) or a Maestro starter flow you add taps to (Pro and Team). CLI 1.9.0.
npx appforshare devices import firebase-udids.txt
eas device:list --json | npx appforshare devices import -
npx appforshare devices export --out devices.txt
npx appforshare test-plan 12345 --format firebase --out tests/app-testing.yaml
firebase apptesting:execute --app=<your Firebase Android app id> --test-dir=tests app-release.apk
npx appforshare test-plan 12345 --format maestro --out .maestro/smoke.yamlSecurity scan in the pipeline
Every uploaded build is scanned for hardcoded keys (shown masked), risky Android and iOS settings and library versions with a known advisory, each finding with an OWASP MASVS category and a fix. security prints the findings (Pro and Team); --fail-on block exits with code 2 when something has to be fixed, --fail-on warn also on warnings. The build stays uploaded. --format json or html saves the full report (Team). The CI build answer carries the counts as security. Findings and hints from a static scan, not a penetration test. CLI 1.22.0.
npx appforshare security 12345
npx appforshare security 12345 --fail-on block
npx appforshare security 12345 --json
npx appforshare security 12345 --format html --out security-report.htmlCheck a build before you upload it
check reads an .ipa, .apk or .aab on your computer or the CI runner and prints the store readiness check, why a phone would refuse to install it (signing, provisioning profile, bundle ID, test only, v1 only signature on API 30 and up) and the security scan counts. Nothing is uploaded, and no account is needed; with a Pro or Team token it also prints each security finding with its fix. Give a folder for its newest build, or nothing to check the folders in appforshare.config.json. Exit code 2 when the result is blocked, also on review with --fail-on review; 1 when the file could not be read. In the GitHub Action, check: true does this before the upload and stops the step without uploading. The same rules run on every upload, so the answer matches. Guidance, not a promise of store approval.
npx appforshare check build/app-release.aab
npx appforshare check build/ios/ipa --fail-on review
npx appforshare check app.apk --json > check.json
# GitHub Action
- uses: appforshare/appforshare-action@v1
with:
token: ${{ secrets.APPFORSHARE_TOKEN }}
file: build/app/outputs/flutter-apk/app-release.apk
check: trueTokens: read only, upload only and an end date
A token can be full (everything your role allows, the default), upload (reads and uploads only) or read only (lists, build details and check), and can stop working after 1 to 365 days. Make one under Settings, API tokens, or with tokens create from a full token; the token is printed once. whoami shows the name, scope, end date and last use of the token in use. Tokens made before scopes existed are full with no end date. Pro and Team.
npx appforshare tokens create "GitHub Actions" --upload-only --expires-in-days 90
npx appforshare tokens create "Release dashboard" --read-only
npx appforshare tokens
npx appforshare tokens revoke 12
npx appforshare whoamiRestore, webhooks and uploads from a URL
restore brings back a build deleted in the last 7 days (no argument lists them). webhooks lists your webhooks with their events and last error, test sends a test message, deliveries shows the last 30 deliveries and redeliver sends one again with the same body (Owner and Admin). Adding a webhook stays in the dashboard, where its URL is pasted; no command prints a webhook URL or secret. upload --url has AppForShare download a build from a public https link, such as a GitHub release asset or a signed CI artifact link: the size is checked first, and http, private and local addresses are refused, also after a redirect. The new link.expiring webhook event fires 24 hours before an install link stops. Pro and Team.
npx appforshare restore
npx appforshare restore Stw0Ae
npx appforshare webhooks
npx appforshare webhooks deliveries 3
npx appforshare webhooks redeliver 18342
npx appforshare upload --url https://github.com/acme/app/releases/download/v2.4.0/app-release.apk --channel betaGradle plugin (Android)
Every variant gets appforshareUpload<Variant>, which builds and sends the APK, and appforshareUpload<Variant>Bundle, which sends the .aab (testers get a universal APK made from it). The result is written to build/appforshare/<task>.json with url, slug, readiness and channelUrl. Works with the Android Gradle Plugin 8 and 9 and the configuration cache. Published on the Gradle Plugin Portal as io.appforshare.upload.
// app/build.gradle.kts
plugins {
id("com.android.application")
id("io.appforshare.upload") version "1.0.0"
}
appforshare {
releaseNotes = "Fixes the login crash" // or releaseNotesFile = file("notes.txt")
channel = "beta"
groups = listOf("Client QA") // Team
testers = listOf("[email protected]") // Team
failOn = "blocked" // or "review"
}
// APPFORSHARE_TOKEN=afs_... ./gradlew appforshareUploadReleasefastlane: testers, groups and UDIDs
Since plugin 1.2.0, appforshare takes groups: and testers:, and new actions manage testers and groups (Team), write your UDIDs for register_devices, and read the newest build so you can raise the build number.
lane :devices do
appforshare_udids(output_file: "devices.txt")
register_devices(devices_file: "devices.txt")
match(type: "adhoc", force_for_new_devices: true)
end
lane :beta_android do
latest = appforshare_latest(app: "com.example.shop", platform: "android")
increment_version_code(version_code: latest["versionCode"].to_i + 1)
gradle(task: "assembleRelease")
appforshare(groups: "Client QA", testers: "[email protected]")
end
# Also: appforshare_add_testers, appforshare_remove_testers,
# appforshare_create_group, appforshare_delete_groupMore commands
The same token reads and tidies the builds of its account. send-feedback makes a Linear or Jira issue from a tester report once a tracker is connected; feedback-task adds it to the project's task board and activity lists what happened (Team). feedback reply 678 --text "..." answers a tester by email; they can answer once on the install page (Team, CLI 1.21.0). link pauses an install link, opens it at a set time (--start, an ISO time such as 2026-12-01T09:00Z, or a date for midnight UTC), stops it after a date (end of that day, UTC) or caps its installs, Pro and Team; off removes a start, date or limit. Before the start, testers see when it opens in their own time zone and can ask for one email at that moment. upload --start sets it at upload, and tester emails for that build wait for it. link add gives a build another share link, for example one per client, with its own label, password, start time, stop date, install cap and count (Pro 3 per build, Team 20); link list shows them, link edit changes one and link rm turns one off. link code add makes a one off access code for a build or an extra link (Team, Owner or Admin): a label for the tester or client and --devices, from 1 to 50, default 1. The tester types it on the install page instead of the shared password. The code is printed once; link code list shows devices used and state, link code revoke turns one off and link code rm deletes it (CLI 1.15.0). link 12345 --test-login [email protected] --test-password-stdin adds a test account testers see on the install page behind its password or an access code, or as invited testers of a private project; --test-note adds a note, the same user name replaces it, up to 3 per build. --channel beta --app com.example.app instead of a build sets it for every build in that channel. --test-logins lists user names (never passwords), --remove-test-login <user|all> removes them (Pro and Team to add, any plan to remove, CLI 1.21.0). Use test accounts only. retire marks a broken build so its link sends testers to the newest build and channels skip it (--undo brings it back, Pro and Team). qr saves a print ready QR code of a build, an extra link or a channel as SVG or PNG; --icon puts the app icon in the middle, and it prints the link and its printable "scan to install" sheet. A channel's code never changes, so it can go on a box or a poster. CLI 1.13.0. github-runs lists the GitHub Actions builds AppForShare started; github-runs 42 --explain shows why run 42 failed and how to fix it, written by AI from the failed job's log with secrets taken out (1 AI action, Pro and Team, CLI 1.18.0). Add --json to any command for machine output.
npx appforshare send-feedback 678 --to linear
npx appforshare feedback-task 678
npx appforshare feedback reply 678 --text "Fixed in build 52, please try again."
npx appforshare activity --kind channel
npx appforshare link 12345 --pause
npx appforshare retire 12345 --reason "Crashes on login"
npx appforshare link 12345 --resume --stop 2026-12-31 --max-installs 50
npx appforshare link 12345 --start 2026-12-01T09:00Z
npx appforshare upload MyApp.ipa --start 2026-12-01T09:00Z
npx appforshare link add 12345 --label "Client A" --password acme-2026 --start 2026-12-01T09:00Z --stop 2026-12-31 --max-installs 25
npx appforshare link list 12345
npx appforshare link rm Qm3xT9
npx appforshare link code add 12345 --label "Ana at Client A" --devices 2
npx appforshare link code list 12345
npx appforshare link code revoke 41
echo "$TEST_PASSWORD" | npx appforshare link 12345 --test-login [email protected] --test-password-stdin --test-note "Admin role"
npx appforshare link 12345 --test-logins
npx appforshare qr Stw0Ae --icon --out qr.svg
npx appforshare qr my-app-beta --icon --out qr.png --size 1024
npx appforshare badge my-app-beta --markdown >> README.md
npx appforshare builds --platform ios --limit 5
npx appforshare latest --app com.example.app
npx appforshare info Stw0Ae
npx appforshare delete Stw0Ae --yes
npx appforshare feedback Stw0Ae --status open
npx appforshare github-runs
npx appforshare github-runs 42 --explain
npx appforshare whoamiMac right click upload
For people who would rather not open a terminal for every build. Install the CLI once, save your token with login (Finder cannot see APPFORSHARE_TOKEN from your shell) and add the Quick Action. Then right click an .ipa, .apk, .aab or zipped .app in Finder and pick Quick Actions, Upload to AppForShare. When the build is ready the install link is on your clipboard and a window shows it with an Open link button, or the error. Other files are skipped with a notice. After you update Node or move the CLI, run install again; status tells you. uninstall removes it. macOS only, CLI 1.14.0, Pro and Team like every token upload.
npm install -g appforshare
appforshare login
appforshare quick-action install
appforshare quick-action status
appforshare quick-action uninstallOptions
--notesor--notes-file: release notes for testers--comment: the same as--notes, for scripts moved from Diawi--password: protect the install link with a password (4 to 128 characters)--email [email protected],[email protected]: email the install link to up to 5 addresses when the build is ready (Pro and Team)--start 2026-12-01T09:00Z: the link opens for installs at that time; testers see when, and tester emails wait for it (Pro and Team)--ios-notesand--android-notes: notes for one platform, when one run sends both--channel beta: put the build into a channel and print its stable link too--groups,--testersor--testers-file: share the build with tester groups and people when it is ready (Team, CLI 1.9.0)--json: prints url, slug, name, version, expiry and channel as JSON--fail-on blockedor--fail-on review: exit with code 2 when the store readiness check finds that level. The build stays uploaded and its link works.--no-wait: return as soon as the upload is queued- Big builds go up in 32 MB chunks and resume after a dropped connection.
- Files:
.ipa, a zipped.app(turned into an .ipa),.apkor.aab. An .aab is turned into one APK for testers, signed with your account's test key or your own upload key (how it works).