@brookesia/simulator-binary-linux-amd64-unknown

Linux x64 (amd64) binary bundle for the ESP-Brookesia system simulator.

This package contains the pre-built brookesia_simulator executable and the .brookesia/ runtime storage bundle for the ESP-Brookesia System Simulator (brookesia simulate --target system).

Contents

@brookesia/simulator-binary-linux-amd64-unknown/
├── brookesia_simulator            # Fully static x86-64 ELF executable
├── .brookesia/
│   └── fs/
│       └── littlefs/
│           ├── apps/               # Built-in runtime apps staged by simulator build
│           └── system/             # System UI resources and shell/startup documents
├── README.md
└── package.json

Installation

This is the Linux x64 platform-specific optional dependency used by the toolkit simulator packages. End users normally install esp-brookesia-toolkit, which pulls in the matching optional binary package through @brookesia/simulator.

{
  "optionalDependencies": {
    "@brookesia/simulator-binary-linux-amd64-unknown": "^0.1.4"
  }
}

pnpm / npm will automatically download the correct platform variant when optional dependencies are enabled.

Manual install (for testing / CI)

pnpm install -g @brookesia/simulator-binary-linux-amd64-unknown

Manual installation is useful when testing @brookesia/simulator directly, but normal CLI usage should install esp-brookesia-toolkit.

How the CLI finds the binary

The resolution chain in @brookesia/shared-utils is:

1. Platform binary package — resolve @brookesia/simulator-binary-linux-amd64-unknown/package.json, then look for the binary at the package root.
2. Toolkit fallback — resolve esp-brookesia-toolkit/package.json, then look under its simulator/ directory.
3. Monorepo fallback — resolve packages/simulator-binary/linux-amd64-unknown relative to the workspace.

You can override auto-detection with:

export BROOKESIA_SIMULATOR=/path/to/brookesia_system_simulator
brookesia simulate --target system

Build & Publish

This package is published from staged artifacts. The binary is built from simulator/, then copied into this package together with its .brookesia/ storage bundle.

Local staging

# Step 1: Build the fully static system simulator
cd simulator
scripts/build_executable.sh

# Step 2: Stage binary + .brookesia storage resources into this package
cd ..
pnpm run stage:simulator -- simulator/build/system_static/bin/brookesia_system_simulator

# Step 3: Publish
cd packages/simulator-binary/linux-amd64-unknown
npm publish

Pre-publish validation

The prepublishOnly script verifies:

• brookesia_simulator exists at the package root
• .brookesia/fs/littlefs/apps exists
• .brookesia/fs/littlefs/system exists

The generated binary and .brookesia/ storage bundle are included in the npm tarball via:

{
  "files": ["brookesia_simulator", ".brookesia", "README.md"]
}

Platform variants

| Package | OS | Arch | | --- | --- | --- | | @brookesia/simulator-binary-linux-amd64-unknown | Linux | x64 |

Additional platform packages can be added following the same pattern.