Browse the documentation

Early preview

Your first binary

This walkthrough wraps a Python uvicorn project into one signed binary for Linux x86_64, in six commands. The same steps apply to Go, Rust, C and C++ binaries, JVM applications and Node.js projects.

1. Scaffold oee.yaml

In your project's directory, let the Executor detect the project (pyproject.toml, requirements.txt, go.mod, pom.xml or package.json) and write an annotated manifest with the sandbox enabled:

oee init --lang python --sandbox

Or answer guided questions instead (application, runtime, start command, exit events, CPU and memory caps, auto-scaling) to produce the same oee.yaml:

oee init --interactive

Guided configuration walks through every question.

2. Validate it

Check the manifest's syntax, sandbox path permissions, cron expressions, JSONPath queries and environment variable references before you build:

oee validate -f oee.yaml --strict

3. Generate signing keys

Create an Ed25519 key pair: oee.key, the private signing key, and oee.pub, the public verification key that is embedded in the supervisor.

oee keygen --out-dir ./certs

Keep oee.key private, as you would any signing key.

4. Build the binary

Package the application, its portable runtime and the signed policy into one executable for Linux x86_64:

oee build \
  -f oee.yaml \
  --target linux-x86_64 \
  --sign-key ./certs/oee.key \
  -o ./dist/my-service

./dist/my-service is the one file you ship.

5. Inspect and verify it

Verify the OEE! footer, the BLAKE3 Merkle root and the Ed25519 signature, and print the embedded policy summary, the target operating system and architecture, and the bundled runtime versions:

oee inspect ./dist/my-service --verify-key ./certs/oee.pub

6. Run it

Run the binary directly. Secrets for exit events come from the environment, and command-line flags pass through to your application when the manifest sets passthrough_cli_args: true:

OEE_API_KEY="sec_live_98a7bc..." ./dist/my-service --log-level info

Try a command before you build

oee run runs any local command under the Executor's sandbox and exit events without building a binary first, which is the quickest way to try a policy:

oee run -f oee.yaml -- python -m uvicorn app.server:api --port 8000

Watch and stop it

oee status
oee stop --all --mode graceful

oee status reports the process tree, sandbox state, uptime, the last exit-event poll, the resolved caps with current usage, replicas and load-balancer health. oee stop stops an instance cleanly.

Next