Runtime
Stoobly Scaffold Runtime Options - Questions & Answers
The --runtime option when creating a scaffold app determines whether workflows run locally on your machine (default) or in Docker containers. You can only specify one runtime option at a time: either local or docker, but not both.
📚 Related Documentation:
Understanding Runtime Options
Q: What runtime options are available for scaffold apps?
A: Scaffold supports two runtime options: local (native execution on your machine) and docker (containerized execution).
Example:
# Local (default - no option needed)
stoobly-agent scaffold app create my-app
# Or explicitly specify local
stoobly-agent scaffold app create my-app --runtime local
# Docker only
stoobly-agent scaffold app create my-app --runtime dockerQ: What's the difference between local and Docker runtime?
A: Local runtime executes workflows directly on your machine using your installed Python and dependencies, while Docker runtime runs workflows in isolated containers with consistent environments.
Example:
Q: Which runtime option should I choose?
A: Use local (default) for faster iteration and simpler setup, or Docker for team consistency and isolation. You can only choose one runtime option per app.
Example:
Q: What's the usage difference between local and Docker runtime?
A: The main difference is in the commands you use to run workflows. Local runtime uses direct CLI commands, while Docker runtime uses Makefile commands.
Example:
For more details:
Switching From One Runtime To Another
Q: Do both runtimes use the same configuration?
A: Yes, both runtimes share the same service configurations, workflows, and recorded data. However, you can only choose one runtime option when creating an app.
Example:
Q: Can I switch between local and Docker runtime after creating the app?
A: Yes, you can recreate the app with a different runtime option. Note that you can only use one runtime option at a time.
Example:
Runtime-Specific Workflows
Q: How do I use a specific runtime?
A: The runtime is determined when you create the app. Use CLI commands for local runtime, or Makefile commands for Docker runtime.
Performance Considerations
Q: Which runtime is faster for development?
A: Local runtime typically has faster startup times, while Docker provides better isolation and consistency.
Example:
Q: Does Docker runtime use more resources?
A: Yes, Docker adds overhead for containerization, but provides better isolation and cleanup.
Example:
For optimization tips:
Docker runtime: See docker.md for performance optimization.
Local runtime: Generally requires no special optimization.
Team Collaboration with Different Runtimes
Q: How do I set up a project that works for team members with different preferences?
A: Choose one runtime for the project. Team members can recreate the app with their preferred runtime if needed, as configurations are shared.
Example:
Q: How do I ensure consistency when team members use different runtimes?
A: Use the same service configurations and share recorded data via version control.
Example:
Q: Can local and Docker users work on the same project simultaneously?
A: If the app was created with one runtime, team members using a different runtime will need to recreate the app with their preferred runtime. They should use different workflow namespaces to avoid conflicts.
Example:
Migration Between Runtimes
Q: How do I migrate between runtimes?
A: Recreate the app with the desired runtime and use the appropriate commands.
From Docker to local: See local.md for migration steps.
From local to Docker: See docker.md for migration steps.
Q: Will my recorded data work with both runtimes?
A: Yes, recorded data is stored in .stoobly/ and works with both runtimes.
Example:
Quick Reference
Q: What's a quick comparison of local vs Docker runtime?
A: Here's a side-by-side comparison:
Local Runtime:
✅ Faster startup
✅ Simpler debugging
✅ Less resource usage
✅ No Docker required
❌ Requires Python 3.10+
❌ Less isolation
❌ Environment differences possible
Docker Runtime:
✅ Consistent across all environments
✅ Complete isolation
✅ Easy cleanup
✅ Works on Windows, Mac, Linux
❌ Slower startup
❌ Requires Docker installed
❌ More resource usage
Example:
Q: What's the recommended setup for a new team project?
A: Choose one runtime based on your team's needs. Local (default) offers faster iteration, while Docker provides consistency.
Example:
Last updated
Was this helpful?