Electrode Native
v0.41
v0.41
  • Introduction
  • INTRODUCTION
    • Overview
      • What is Electrode Native
      • Why use Electrode Native
      • What is a MiniApp
      • Electrode Native workflow
      • Native dependencies management
      • JS/Native communication
      • Requirements
      • Upgrading Electrode Native
      • Contributing
  • REFERENCE
    • Bundle Store
    • Composite
    • Container
      • What's inside
      • Publication
      • Integration
      • Initialization
      • Launching MiniApps
    • Cauldron
      • Structure
      • Setup
      • Compatibility checks
      • Guidelines
    • Manifest
      • Override
      • Native Modules
      • Configurable Modules
    • Runner
    • APIs
      • Project Generation
      • Implementation
      • Versioning
      • Guidelines
    • Bridge
      • Message Types
      • Communication
      • Leveraging APIs
    • CLI
      • Global CLI
      • Local CLI
    • GLOSSARY
  • GUIDES
    • Debugging multiple MiniApps
  • CLI COMMANDS
    • add
    • bundlestore
      • create
      • delete
      • upload
      • use
    • binarystore
      • add
      • get
      • remove
    • code-push
      • patch
      • release
      • promote
    • compat-check
    • create-api-impl
    • create-api
    • create-composite
    • create-container
    • create-plugin-config
    • publish-container
    • transform-container
    • create-miniapp
    • link
    • regen-api
    • regen-api-impl
    • run-android
    • run-ios
    • start
    • unlink
    • upgrade-miniapp
    • cauldron add
      • file
      • jsapiimpls
      • miniapps
      • nativeapp
    • cauldron config
      • get
    • cauldron del
      • file
      • jsapiimpls
      • miniapps
      • nativeapp
    • cauldron get
      • config
      • dependency
      • nativeapp
    • cauldron repo
      • add
      • clear
      • current
      • list
      • remove
      • use
    • cauldron update
      • file
      • jsapiimpls
      • miniapps
      • nativeapp
    • cauldron batch
    • cauldron regen-container
    • cauldron upgrade
    • cauldron why
    • github
      • github create-ref
      • github delete-ref
      • github align-dependencies
    • platform
      • plugins
        • list
        • search
      • config
        • set
        • get
        • del
        • list
      • install
      • versions
      • uninstall
      • use
Powered by GitBook
On this page
  • Description
  • Syntax
  • Remarks
  1. CLI COMMANDS

run-ios

Previousrun-androidNextstart

Last updated 4 years ago

Description

  • Runs a MiniApp on an iOS emulator or connected device

Syntax

ern run-ios

Options

--baseComposite <compositePath>

  • Git or File System path, to the custom Composite repository (refer to the documentation for more information).

--descriptor, -d

  • complete native application descriptor

--dev [true|false]

  • Enable or disable React Native dev support

--host

  • Host or ip to launch the local packager on.

  • By default it will use the IP address that is returned by the ipconfig getifaddr en0 command, and fallback to localhost in the case the command fails.

    --launchArgs

  • Arguments to pass to the application when launching it (correspond to the Arguments Passed On Launch in application scheme run config in XCode as can be seen on screenshot below).

  • Make sure to use = on the command line to provide this option, and keep the string in quotes. For example --launchArgs="-ArgA -ArgB"

--launchEnvVars

  • Environment variables to pass to the application when launching it (correspond to the Environment Variables in application scheme run config in XCode as can be seen on screenshot below).

  • Make sure to use = on the command line to provide this option, and keep the string in quotes. The string should contain key=value pairs delimited by spaces. For example --launchEnvVars="aKey=aValue anotherKey=anotherValue"

--mainMiniAppName

  • Name of the MiniApp to launch when starting the Runner application

--miniapps/m

  • One or more MiniApps to combine in the Runner Container

--port

  • Port on which the local packager should listen on (default: 8081)

--usePreviousDevice/-u

  • Use the previously selected device to avoid prompt

Remarks

  • You can launch the MiniApp located in the current working directory or on a connected iOS device or running emulator if available. If a connected iOS device is not available, the command prompts you to select an emulator to launch from the list of installed emulator images.

  • The first time you run this command from within a MiniApp directory, it generates an iOS directory containing the iOS Runner application project. If the iOS folder already exists (it is not the first run of the ern run-ios command for this MiniApp), the existing runner project is used.

  • After the runner project is generated, you can safely make native code modifications to it, knowing that the next time the ern run-ios command is issued, the project and your changes will remain.

  • If you want to regenerate the runner project from scratch, remove the iOS directory.

  • The miniapp can be any Yarn package descriptor, including Git or other file system path schemes.

  • The ern run-ios command is the ern equivalent of the react-native run-ios command.

custom Composite
xcode scheme run