Versions and upgrades
oxframe is before 1.0, so its API still changes. Here is how versions are numbered, how often they come out, and how to move a project from one to the next.
How versions are numbered
The SDK crates and the oxframe command are released together under one version. Before
1.0, a release that breaks your code raises the minor number (0.20 → 0.21); a release that only adds
or fixes something raises the patch number (0.21.0 → 0.21.1).
| Release | What it may do | Your code |
|---|---|---|
| 0.21.0 → 0.21.1 | Fix bugs, add new API | Builds unchanged |
| 0.20.x → 0.21.0 | Change or remove API, change a default | May need edits; the changelog shows them |
How often
About once a week. Breaking changes wait for the next minor release and come out together, so you update your scenes once instead of after every change. An urgent fix ships on its own as a patch release. Every release has its own section in the changelog, with a short video of what is new.
Pin the version
oxframe init pins the exact SDK version in Cargo.toml, so a new release
never changes a project behind your back:
[dependencies]
oxframe = "=0.21.0"Keep the =. With a plain "0.21", Cargo may pick a newer patch the next
time the lock file is refreshed.
Upgrade a project
cargo install oxframe-cli # the newest oxframe command
cd my-video
oxframe upgrade # pin this command's SDK, refresh Cargo.lock and the agent files
oxframe check # build, then look at what changedoxframe upgrade moves the project to the SDK version the installed command is made
for, updates Cargo.lock, and refreshes AGENTS.md and the agent skill so
an AI agent writes code for the new version. Then read the changelog sections between your old
version and the new one. A breaking change is listed under Changed or Breaking with a before → after example, which is usually the whole edit.
Docs for your version
These docs describe the newest release. The version menu at the top of the docs switches to the
pages of an older one, kept as they were: /docs/0.20.5/…, /docs/0.19.0/… and so on. The API reference on docs.rs is per version too. For an AI agent, point it at the docs of
the version the project pins: https://oxframe.dev/docs/0.20.5/llms.txt for an older
project, /llms.txt for the newest.