Get started · Claude Code, Codex, Cursor

Use a coding agent

Let your coding agent integrate the SDK. Every guide is available as plain Markdown, so the agent reads the same instructions you do.

Before you start

Set up your app in the dashboard. App Settings → Set up SDK provides these prompts with your public SDK key filled in; the versions here use the placeholder YOUR_API_KEY.

iOS prompt

Paste this into your agent from the root of your iOS project:

Integrate Mobile Joe into this iOS app using SwiftUI.
Read https://docs.mobilejoe.dev/llms.txt and https://docs.mobilejoe.dev/ios/quickstart.md first.
Use SDK 1.0.1 (Exact Version) from https://github.com/MobileJoeDev/mobilejoe-ios.git.
Requirements: iOS 17+, Swift 6.2+, and Xcode 26+. Add both MobileJoe and MobileJoeUI package products to the app target.
Preserve the app's existing startup, theme, and navigation. Adapt this shared configuration to the existing SwiftUI App entry point and root view:

import SwiftUI
import MobileJoe

@main
struct MyApp: App {
  init() {
    try? Joe.configure(withAPIKey: "YOUR_API_KEY")
  }

  var body: some Scene {
    WindowGroup {
      ContentView()
    }
  }
}

Use the public SDK key above for this app in Mobile Joe. Call Joe.configure in the App initializer, before any Mobile Joe view appears, not in .task. Follow the quickstart's error handling.
Add a first FAQ integration using FAQView and the presentation and support options at https://docs.mobilejoe.dev/ios/faqs.md.
Publish a FAQ in the same app in Mobile Joe, then display its question and answer in the app.
Run the app and verify the iOS connection confirmation in App Settings → Set up SDK → iOS (https://app.mobilejoe.dev/setup?platform=iOS), then verify the published FAQ and its refresh behavior.
Relevant tool guides: https://docs.mobilejoe.dev/ios/feature-plans.md and https://docs.mobilejoe.dev/ios/alerts.md. Do not add additional tools unless requested or invent SDK APIs.
If configuration fails or content is missing, follow https://docs.mobilejoe.dev/sdk/troubleshooting.md.
Report the exact SDK version, build result, device validation, and anything you could not verify.

Android prompt

Paste this into your agent from the root of your Android project:

Integrate Mobile Joe into this Android app using Kotlin and Jetpack Compose.
Read https://docs.mobilejoe.dev/llms.txt and https://docs.mobilejoe.dev/android/quickstart.md first.
Use SDK 1.0.2 (dev.mobilejoe:mobilejoe-ui-compose) from Maven Central.
Requirements: Android 8.0+ (API 26), compileSdk 35+, Android Gradle Plugin 8.6+, and Kotlin 2.1+.
Preserve the existing Application, activity, theme, and navigation. Call Joe.configure directly in Application.onCreate, without a coroutine. Adapt this startup configuration:

import android.app.Application
import dev.mobilejoe.api.Joe

class MyApplication : Application() {
    override fun onCreate() {
        super.onCreate()

        Joe.configure(
            applicationContext = this,
            apiKey = "YOUR_API_KEY",
        )
    }
}

Add the Compose dependency and register the Application class in the manifest as shown in the quickstart.
Display FaqHost with the app's support address after a FAQ is published in the dashboard.
Run the app and verify the Android connection confirmation in App Settings → Set up SDK → Android (https://app.mobilejoe.dev/setup?platform=Android), then verify the published FAQ.
Follow the quickstart's identity, localization, and refresh behavior; do not invent SDK APIs.
If configuration fails or content is missing, follow https://docs.mobilejoe.dev/sdk/troubleshooting.md.
Report the exact SDK version, build result, and any unverified device checks.

Markdown sources

Append .md to any page path for Markdown, for example /ios/quickstart.md. llms.txt indexes all guides, llms-full.txt contains them in one file, and the OpenAPI contract describes the REST API. All files are public.

To let an agent write and publish content in your dashboard instead, see Manage content with AI agents.