FAQ
RunWhale questions, answered
Clear answers about getting started, what runs on your phone, project boundaries, and the fastest checks when something fails.
Last updated:
Choose a question below. The answers describe the current product boundaries without assuming a particular provider, device release, or distribution channel.
Getting started
What do I need before the first Agent run?
Choose a provider and model in Settings → Models, save a valid API key from that provider, and keep the device online. Then create a Web or Expo project, or import a compatible repository.
Should I choose a Web or Expo project?
Choose Web for a React website that runs in Web Preview. Choose Expo for a React Native project that runs in Native Preview inside RunWhale's fixed native shell. Both templates support the same project-and-Agent workflow.
Can I import an existing repository?
Yes, when the repository is compatible with RunWhale's Web or Expo runtime. Imported projects use runwhale.json to declare their entry points and Preview target. Repositories that require unsupported native code, binaries, or build steps will not fit the current runtime.
Local runtime and data
Does everything run locally, and is RunWhale offline?
Project files, Agent orchestration, sessions, Node.js and TypeScript tooling, supported tasks, Git, Metro, and Preview run on the phone. Model inference uses your configured remote provider. Explicit Git network operations and uncached dependency downloads also use the network, so RunWhale is not an offline product.
What project data can reach the model provider?
When you run the Agent, RunWhale sends your prompt and the project or session context needed to answer it to the provider you selected. Depending on the request, that context can include source code, file contents, images, tool results, and conversation history.
Where are API and Git credentials stored?
Model API keys and the device Git private key stay in iOS Keychain or Android Keystore. They are not written to project files, environment variables, Git configuration, Agent sessions, logs, or Preview bundles.
Compatibility and limits
Can RunWhale use a private Git repository?
Yes, for GitHub repositories over SSH. In Settings → Git SSH key, generate or copy the device public key, add that public key to GitHub, and use the repository's GitHub SSH URL. The private key remains in the device's secure storage; access still depends on the network and the repository permissions granted on GitHub.
Can a project install any npm package?
No. RunWhale supports compatible pure-JavaScript packages from the npm registry. Lifecycle scripts and binary links are disabled; Git or path dependencies, native addons or binaries, dynamic Expo config plugins, and project-specific native SDKs are not supported. Depending on your permission mode, RunWhale may ask you to approve an install.
Does RunWhale build standalone iOS or Android apps?
No. User projects run as Web or React Native Preview targets inside RunWhale. They do not trigger Xcode, Gradle, EAS, IPA, or APK builds.
Does Agent or Metro work continue in the background?
Do not depend on continuous background execution. In particular, the current product does not keep Agent or Metro running continuously while iOS is backgrounded. Keep RunWhale in the foreground for an active development turn or Preview build.
Troubleshooting
Why won't the Agent start?
Confirm that the selected provider has a valid saved API key and that the device is online. If RunWhale reports a local Runtime failure, restart the Runtime and try again before changing the project.
Why won't Web or Native Preview open?
Use the refresh icon (labeled Run / Reload), then confirm that runwhale.json declares the intended Preview target and a matching Web or native entry. Read the displayed Metro or Native Preview diagnostic; use that exact non-sensitive message when asking the Agent to fix the project.
Why did Git clone, fetch, pull, or push fail?
Check that the repository uses a supported HTTPS URL or a GitHub SSH URL, then verify the selected branch, network connection, and remote permissions. For GitHub SSH, confirm that the device's current public key is registered on GitHub. Pull also requires a clean worktree, and URLs with embedded credentials are rejected.
What should I include in a support report?
Include the RunWhale version, device model, operating system version, action you attempted, exact error, smallest reproduction steps, and any non-sensitive diagnostic shown by the app. Never include API keys, private keys, credentials, private project data, personal data, or unsanitized logs and screenshots.
Still need help?
Use the step-by-step guide for the complete first workflow, or contact support when you have a private question or a reproducible problem.