Skip to content
df12
Tools
Creative
Docs
About
Menu
Tools
Creative
Docs
About
Contents
Introduction
Introduction
Prerequisites
Prerequisites
Installation
Installation
Bundled simulator assets
Bundled simulator assets
Installing Simulacrum dependencies
Installing Simulacrum dependencies
Compatibility matrix
Compatibility matrix
Known incompatibilities and workarounds
pytest Fixtures
pytest Fixtures
github_sim_config (advanced)
Helper Functions
Simulator Orchestration
Simulator Orchestration
Starting the Simulator
Stopping the Simulator
Empty Configuration
Error Handling
Custom Bun Executable
Scenario configuration helpers
Scenario configuration helpers
Example: single repo, single user
Example: multiple repositories with public and private visibility
Optional issues and pull requests
Named scenario factories
Authentication tokens
GitHub App installation metadata
Authentication mode limitations
Configuration Schema
Configuration Schema
User Schema
Repository Schema
Branch Schema
Pytest fixtures
Pytest fixtures
Scenario fixtures
github_sim_config
github_simulator
Environment Variables
Environment Variables
Running tests
Running tests
Continuous integration (CI) reference projects
Continuous integration (CI) reference projects
Troubleshooting
Troubleshooting
Simulator startup failures
Configuration serialization errors
`github3.py` and simulator coverage mismatches
API stability
API stability
Deprecation policy
Deprecation policy
Changelog
Changelog
Environment Variables
Updated Jul 14, 2026
Variable
Description
Default
BUN
Path to the Bun executable
bun