diff --git a/src/content/docs/docs/cli/cloud-build/getting-started.mdx b/src/content/docs/docs/cli/cloud-build/getting-started.mdx index a33700097..cda584f66 100644 --- a/src/content/docs/docs/cli/cloud-build/getting-started.mdx +++ b/src/content/docs/docs/cli/cloud-build/getting-started.mdx @@ -5,7 +5,7 @@ sidebar: order: 1 --- -import { Steps, Card, CardGrid } from '@astrojs/starlight/components'; +import { Steps, Card, CardGrid, Aside } from '@astrojs/starlight/components'; Get started with Capgo Cloud Build and create your first iOS or Android native build in minutes. @@ -169,19 +169,50 @@ iOS builds require signing certificates and provisioning profiles. See [iOS Buil ## What Gets Built -**Important:** Capgo Cloud Build only builds the **native parts** of your app (iOS and Android native code). +Capgo Build only uploads the **minimum files needed** to compile your native app. Your full source code never leaves your machine. -You are responsible for: -- Building your web assets (`npm run build`) -- Running `npx cap sync` before the build -- Ensuring all dependencies are in `package.json` +### What Gets Uploaded + +| Included | Description | +|----------|-------------| +| `ios/` or `android/` | The native platform folder you're building | +| `package.json`, `package-lock.json` | Dependency manifest | +| `capacitor.config.*` | Capacitor configuration | +| `resources/` | App icons, splash screens | +| Native plugin code | Only the `ios/` or `android/` subfolder of each Capacitor plugin | + +### What's NOT Uploaded + +| Excluded | Why | +|----------|-----| +| `node_modules/` (most of it) | Only native plugin code is included, not JS dependencies | +| `src/` | Your web source code stays local | +| `dist/`, `www/`, `build/` (root level) | Already synced into the native folder via `cap sync` | +| `.git/` | Version control history | +| `.gradle/`, `.idea/`, `.swiftpm/` | Build caches and IDE settings | +| `.env`, secrets | Never uploaded | + + + +### Your Responsibilities + +Before running `npx @capgo/cli build`: + +1. **Build your web assets** - Run `npm run build` (or your framework's build command) +2. **Sync to native** - Run `npx cap sync` to copy web assets into the native project +3. **Commit dependencies** - Ensure all native plugins are in `package.json` + +### What Capgo Build Handles -We handle: - Native iOS compilation (Xcode, Fastlane) - Native Android compilation (Gradle) -- Code signing +- Code signing with your credentials - App store submission (if configured) +
+ ## Build Time & Costs Build time is measured from start to completion: @@ -223,14 +254,22 @@ npx @capgo/cli@latest build com.example.app \ ### Multi-Platform Builds -Build for both platforms simultaneously: +Build for both platforms by running two commands: ```bash +# iOS build npx @capgo/cli@latest build com.example.app \ - --platform both \ + --platform ios \ + --build-mode release + +# Android build +npx @capgo/cli@latest build com.example.app \ + --platform android \ --build-mode release ``` +In CI/CD, you can run these in parallel jobs for faster builds. + ## Next Steps Now that you've created your first build: diff --git a/src/content/docs/docs/cli/cloud-build/index.mdx b/src/content/docs/docs/cli/cloud-build/index.mdx new file mode 100644 index 000000000..7a7c06515 --- /dev/null +++ b/src/content/docs/docs/cli/cloud-build/index.mdx @@ -0,0 +1,127 @@ +--- +title: Introduction to Capgo Build +description: Build iOS and Android apps in the cloud without local setup. No Mac required for iOS builds. +sidebar: + order: 0 + label: Introduction +--- + +import { Card, CardGrid, Aside, LinkCard } from '@astrojs/starlight/components'; + +Capgo Build is a cloud-based native app compilation service for Capacitor apps. It lets you build iOS and Android apps without maintaining local development environments - no Xcode, no Android Studio, no Mac hardware required. + +## What Capgo Build Does + +Capgo Build compiles the **native parts** of your Capacitor app in the cloud: + +- **iOS builds** run on dedicated Apple Silicon (Mac Mini M4) machines +- **Android builds** run in isolated Docker containers +- **Automatic code signing** handles certificates, provisioning profiles, and keystores +- **Direct store submission** uploads signed apps to App Store Connect and Google Play + +You trigger builds with a single CLI command that works from anywhere - your local machine, GitHub Actions, GitLab CI, or any CI/CD pipeline. + +## When to Use Capgo Build vs Live Updates + +Capgo offers two complementary features for updating your app. Here's when to use each: + +| Scenario | Live Updates | Capgo Build | +|----------|:------------:|:-----------:| +| Bug fix in JavaScript/TypeScript code | ✓ | | +| UI changes (HTML, CSS, images) | ✓ | | +| Updating web dependencies | ✓ | | +| Adding or removing a Capacitor plugin | | ✓ | +| Updating a native SDK version | | ✓ | +| Changing native permissions (Info.plist, AndroidManifest) | | ✓ | +| Updating Capacitor version | | ✓ | +| Modifying native code (Swift, Kotlin, Java) | | ✓ | +| Changing app icon or splash screen | | ✓ | +| First app store submission | | ✓ | + + + +## Why Use Capgo Build + + + + Build and ship iOS apps without Mac hardware. Anyone on Windows, Linux, or any CI/CD system can trigger iOS builds and publish to TestFlight. + + + + No need to install Xcode, Android Studio, or manage SDK versions. Capgo Build handles all native tooling - you just run the CLI command. + + + + Store your certificates and keystores in your CI/CD secrets once. Any team member can trigger builds without needing signing credentials on their local machine. + + + + A single CLI command integrates with any pipeline. GitHub Actions, GitLab CI, Jenkins - trigger builds as part of your existing workflow. + + + + Watch your build progress live in your terminal. Logs stream via Server-Sent Events so you can debug issues instantly as they happen. + + + + Signed apps upload directly to App Store Connect and Google Play. No manual steps between build completion and store submission. + + + +## How It Works + +When you run the build command: + +1. **Upload** - The CLI zips only what's needed (native platform folder + native dependencies) and uploads to secure cloud storage +2. **Build** - Your app compiles on dedicated infrastructure using Fastlane +3. **Sign** - Certificates and keystores are applied (they exist only in memory during the build) +4. **Submit** - Signed apps are uploaded directly to App Store Connect or Google Play +5. **Cleanup** - All build artifacts and credentials are automatically deleted + +Your source code stays on your machine. Only the platform-specific native code is uploaded. + +## Security Model + +Capgo Build is designed with zero credential storage: + +- **Runtime-only credentials** - Certificates and keystores are never stored in Capgo. They are uploaded and removed immediately after the build finishes. +- **Ephemeral environments** - Each build runs in isolation and is destroyed after completion +- **No log storage** - Build logs stream to your terminal only, never stored on Capgo servers +- **Minimal upload** - Only the native platform you request is uploaded, not your full codebase. [See exactly what gets uploaded](/docs/cli/cloud-build/getting-started/#what-gets-built) + +## Pricing + +Build time is the only cost: + +- Build minutes are included in your Capgo plan +- Extra minutes available via credit system +- iOS builds run on Mac Mini M4 (2x cost multiplier due to hardware costs) +- Android builds run in Docker containers (1x cost) +- No storage fees + +## Next Steps + + + + + + +