Skip to content
ocx
install

Command ↔ method map

Every typed method mirrors one ocx command. T1 commands are typed and CI-covered; T2 commands are real but not yet typed (reach them through invoke or invoke_async); T3 commands are interactive, shell-session, or not-a-frozen-contract, and stay invoke-only by design; ✗ commands are never wrapped.

Full flag fidelity is scoped to stable, resolution-affecting flags — experimental surfaces (--ci=gitlab and similar) are excluded on purpose.

There is no Ocx.exec. The toolchain runner that mirrors ocx exec is project-tier: ocx.project(path).exec(argv). Raw argv goes through Ocx.invoke. Reaching for Ocx.exec, or for Ocx.run, the name that verb carried before ocx 0.6, raises AttributeError with a pointer to the right method.

Ocx.package is a sibling of Ocx.project(...), not something reached through it. It covers install, select, exec and the author flow (create, test, push), operates on $OCX_HOME directly and takes no project path.

No project path; operates on $OCX_HOME.

ocx command SDK method Tier
ocx version Ocx.version T1
ocx about Ocx.about T1
ocx login Ocx.login T1
ocx logout Ocx.logout T1
ocx status Ocx.project(path).status T1
ocx clean Ocx.clean T1
any command Ocx.invoke / invoke_async / spawn / spawn_async raw escape hatch
ci*, bare aliases — ✗ dead stubs
direnv* — T3, needs human direnv allow
shell allow / shell revoke / shell state — T3, shell-session, needs human consent
self activate, shell completion — T3, shell-session only

Every call carries --project <path> explicitly, so no method reads the working directory.

ocx command SDK method Tier
ocx init --project Project.init T1
ocx add --project Project.add T1
ocx remove --project Project.remove T1
ocx lock --project Project.lock T1
ocx update --project Project.update T1
ocx pull --project Project.pull T1
ocx status --project Project.status T1
ocx inspect --project Project.inspect T1
ocx env --project Project.env T1
ocx exec --project -- CMD Project.exec / exec_async / spawn / spawn_async T1

Continues on Command ↔ method map: Package tier.