Skip to content
Docs0.9GitHubInstall

Running itThe iPhone app

The iPhone app

Get the iPhone and iPad app from TestFlight or build it yourself, pair it, and set up push notifications and Live Activities.

How to get the app onto an iPhone or iPad and connected to your computer, for whoever administers it. The app needs iOS 17 or newer and an address that reaches your app endpoint; set that up first in Publish the apps privately.

The TestFlight link is on vendetta.sh/install. Open it on the iPhone, install TestFlight if asked, and install the app. In TestFlight it is listed as “Vendetta Terminal”; on the home screen it is “Vendetta”.

On the computer:

vendetta app pair

It prints a pairing code, a link, and, with qrencode installed, a QR code. In the app, tap Scan pairing code and scan the QR, or paste the code or link and tap Pair.

  • A code works once, within 10 minutes. Five wrong tries discard it; run the command again for a new one.
  • The phone must reach the address in [plugins.app] public_url. On a tailnet, that means Tailscale is on and connected on the phone.
  • For someone else’s phone, make their code with vendetta instance pair NAME, or from People in your own app. See People.

Settings shows the server’s host, the connection’s state, and This device, its ID. Unpair this device removes the pairing from the phone. To cut a device off from the computer:

vendetta app devices
vendetta app revoke ID

Your own worker sends pushes straight to Apple, signed with an APNs key for the app’s bundle identifier. No Vendetta server sits in between.

[plugins.app.apns]
team_id = "ABCDE12345"
key_id = "KEY1234567"
topics = ["dev.example.vendetta"]   # the apps' bundle identifiers
key = { command = ["/path/to/print-the-p8-key"] }
# preview = true                    # include up to 150 characters of each message
Key Holds
team_id Your Apple Developer team ID
key_id The APNs key’s ID
topics The bundle identifiers of the app builds you push to. A device pushes under the one it registered from.
key Where the .p8 key comes from: { command = [...] } printing it, or { env = "NAME" }. It is read on demand.
preview Whether a push carries the start of the message, up to 150 characters

It also needs curl with HTTP/2 on the computer. Restart the worker after changing credentials.

A turn’s final reply, a question, an approval, an alert or timer that rings, and the pictures, audio, and video an agent sends. In-between responses never push. A muted chat pushes only its agent’s alerts. Reading a chat on any device, or answering its question, removes its notifications on the iPhone and updates the badge.

Settings → Notifications:

Row Does
Enable Notifications Asks iOS for permission. Enable in Settings shows when iOS has it denied.
Alert Sounds An agent’s alert plays aloud while the app is open, even with the ring switch on silent
Live Activities The status activity on the lock screen and in the Dynamic Island, on this iPhone

With [plugins.app.apns] set up for your build, the lock screen shows how many agents need you, a row per busy project, the question waiting longest, and how much usage is left. An agent can show its own with vendetta live. See Following an agent’s progress.

Settings → Notifications → Live Activities turns the status activity off on that iPhone, shows whether iOS allows Live Activities, and says whether the iPhone has registered.

Vendetta is in the share sheet of Photos and other apps: share up to ten files of 256 MB each, a link, or text to the Master, a recent chat, or a new chat in a project. A build signed without the share extension’s profile installs without it.

You need a Mac with Xcode, a stable Rust toolchain, and the checkout. The app lives in ios/.

cd ios
make project
make mobile-build-ipa IPA_OUTPUT=$PWD/Vendetta.ipa

make project regenerates the Xcode project with XcodeGen. mobile-build-ipa builds the shared Rust kit, archives the app without signing, and writes the IPA. IPA_OUTPUT must be an absolute path.

Sign the IPA with your own Apple Developer account, or with a tool that signs on the device. To sign it on the Mac or on Linux with a distribution certificate:

make sign-ipa IPA_INPUT=$PWD/Vendetta.ipa IPA_OUTPUT=$PWD/Vendetta-signed.ipa

sign-ipa needs rcodesign and openssl, and reads these from ~/.local/share/vendetta-ios/signing (or SIGNING_DIR):

File Holds
adhoc.p12, adhoc.password Your distribution certificate and its password
adhoc.mobileprovision The app’s provisioning profile
share.mobileprovision The share extension’s, for the app’s bundle ID plus .share. Optional.
widget.mobileprovision The Live Activities extension’s, for the app’s bundle ID plus .widgets. Optional.
display_name The name under the icon. Optional.

Bundle IDs, the team, App Groups, and the push environment come from the profiles. An extension without a profile is left out of the signed app. The share extension also needs the App Group group. plus the app’s bundle ID on both profiles.

Put your build’s bundle identifier in topics and your team’s APNs key in [plugins.app.apns], as above.