Skip to content
Ramus
Menu
Sign inStart free

Quickstart

There are two ways to start: give your coding agent a device, or upload a build and share it. Both use a Ramus account; sign in with GitHub.

Connect your agent

  1. Add Ramus to your agent. For Claude Code:

    claude mcp add --transport http ramus https://api.ramus.dev/api/mcp

    Codex, Cursor, ChatGPT and other clients are in Connect an agent.

  2. Sign in with Ramus when your agent asks. In Claude Code, run /mcp and choose ramus.

  3. Ask it to check a flow, for example: "Install my debug build on Ramus and check the login screen." It starts a device, installs the build, works through the flow and sends you a link to watch.

An agent with a shell can also use the CLI: npm i -g ramus-cli, then ramus login.

Upload and share

  1. Open the dashboard and drop an APK onto it, or choose Upload app. A progress card shows the upload; choose Cancel to stop it. If the file is rejected, for example because it is not an APK or is too large, the reason appears on the same card.
  2. Ramus starts a device and installs the app. The card steps through Finding a device, Booting Android and Connecting video, and the app opens when video arrives. Click and drag to tap and swipe, and type with your keyboard. The viewer's screenshot and device-log controls show what the app is doing.
  3. Choose Share, pick what the other person can do, and copy the link. They open the running app in their browser, with no account. See Share a running app.

Choose End device when you finish; leaving the page does not end it. You can also choose Open blank device to explore a device without an app. If the app needs a camera or microphone, see Camera and microphone.

Which file to upload

Upload the APK your own build produces. It must run on an x86_64 Android emulator; apps that need unsupported native libraries or device hardware may not run. These commands each make one that installs on its own:

ProjectCommand
Kotlin, Java, or Compose./gradlew assembleDebug
React Native./gradlew assembleRelease in android/
Expoeas build -p android with "buildType": "apk" in the build profile
Flutterflutter build apk

If you only have an Android App Bundle (.aab), convert it to one universal APK set with bundletool and upload the .apks file:

bundletool build-apks --bundle app.aab --output app.apks --mode=universal

Ramus does not accept .aab files directly. An APK downloaded from an app store or mirror site, or copied off a phone, is often only one part of a split app. It fails with INSTALL_FAILED_MISSING_SPLIT because the rest of the app is missing.

Optional: connect GitHub

Install the Ramus GitHub App from the dashboard or Settings and select the repositories it can access. Open a repository in Ramus and enable Automatic PR previews.

Open a same-repository pull request, or push a commit to one that is already open; pull requests your agent opens count too. The Ramus comment tracks the build and links to the preview once it is ready. See Builds for supported project layouts and build troubleshooting.