# ocx_sdk

*module*

Python SDK for [OCX](https://github.com/ocx-sh/ocx).

`ocx-sdk` drives the ocx binary rather than reimplementing it: ocx owns
resolution, verification, and the identifier grammar, and this package gives
you typed, CWD-independent handles over the commands it exposes.

```python
from ocx_sdk import Ocx, bootstrap

ocx = Ocx(exe=bootstrap.ensure())
project = ocx.project("/srv/build")
project.pull()
project.exec(["task", "verify"])
```

**This module is the API.** Everything listed in `__all__` is the stable
surface; every other module is underscored and package-private, and the one
public submodule is `ocx_sdk.bootstrap`. Reaching into an underscored path
means the next release may move it without notice — pre-1.0, breaking
changes ship without shims.

Start at `Ocx` for the runtime API and `bootstrap.ensure` for provisioning.

[View source](https://github.com/ocx-sh/ocx-sdk-python/blob/main/src/ocx_sdk/__init__.py#L1-L1)

## ocx_sdk.PackageCommands

*class* · *dataclass*

```python
class PackageCommands
```

Re-exported from: `ocx_sdk._client`

The `ocx package` command group — machine tier.

Package operations act on the `$OCX_HOME` store and its candidate and
current symlinks. They take no project path and are CWD-independent by
construction; a path appears only where the CLI itself takes one.

Every method is multi-identifier native, mirroring the CLI's `PKG...`
with one shared resolution.

[View source](https://github.com/ocx-sh/ocx-sdk-python/blob/main/src/ocx_sdk/_client.py#L1470-L3367)

### ocx_sdk.PackageCommands.description_push

*method*

```python
def description_push(identifier: PackageLike, *, from_: PackageLike | None = None, readme: str | Path | None = None, logo: str | Path | None = None, title: str | None = None, description: str | None = None, keywords: str | None = None, timeout: MaybeTimeout = UNSET, retry: MaybeRetry = UNSET) -> CommandResult
```

Publish description metadata for a package repository (C-003).

ocx prints no JSON payload for this command (D9) — it logs and
exits, so there is nothing typed to return.

**Parameters**

- `identifier` (`PackageLike`) — The package repository to describe.
- `from_` (`PackageLike | None`) (default: `None`) — Another package to copy the description from, instead of the field arguments below — ocx's `--from` takes a package identifier, not a path (`package_description_push.rs:26-27`). Mutually exclusive with `readme`, `logo`, `title`, `description`, and `keywords`.
- `readme` (`str | Path | None`) (default: `None`) — The README file to publish.
- `logo` (`str | Path | None`) (default: `None`) — The logo file to publish.
- `title` (`str | None`) (default: `None`) — The display title to publish.
- `description` (`str | None`) (default: `None`) — The prose description to publish.
- `keywords` (`str | None`) (default: `None`) — A single delimited keywords string, **not** a list — ocx's own field is a bare string (C-021).
- `timeout` (`MaybeTimeout`) (default: `UNSET`) — Seconds per attempt. Omitted takes the config's.
- `retry` (`MaybeRetry`) (default: `UNSET`) — Retry policy. Defaults to no retries — this is a registry write (D5).

**Returns**

- (`CommandResult`) — The exit code and whatever ocx printed.

**Raises**

- `ValueError` — Neither `from_` nor any of the five field arguments
was given, or `from_` was given alongside one of them.
- `NotFoundError` — `from_` names a source that carries no
description (exit 79).

[View source](https://github.com/ocx-sh/ocx-sdk-python/blob/main/src/ocx_sdk/_client.py#L2287-L2355)

### ocx_sdk.PackageCommands.exec

*method*

```python
def exec(refs: Sequence[PackageLike], argv: Sequence[str], *, platform: str | None = None, clean: bool = False, private: bool = False, env: Mapping[str, EnvValue] | None = None, lazy_mode: LazyMode | None = None, records_dir: str | Path | None = None, records_name: str | None = None, capture: bool = True, check: bool = True, timeout: MaybeTimeout = UNSET) -> CommandResult
```

Run a command in a set of packages' composed environment.

Two positional groups, mirroring the CLI's `PKG... -- CMD...`. The
child's exit code comes back byte for byte; child processes are
never retried.

**Parameters**

- `refs` (`Sequence[PackageLike]`) — Package identifiers to compose.
- `argv` (`Sequence[str]`) — The command and its arguments. Must not be empty.
- `platform` (`str | None`) (default: `None`) — The platform to resolve against.
- `clean` (`bool`) (default: `False`) — Strip the ambient parent environment before composing.
- `private` (`bool`) (default: `False`) — Compose the private surface — ocx's `--self`.
- `env` (`Mapping[str, EnvValue] | None`) (default: `None`) — Extra `[env]` entries for this call.
- `lazy_mode` (`LazyMode | None`) (default: `None`) — When content downloads — now, or on first use.
- `records_dir` (`str | Path | None`) (default: `None`) — Write an execution record — the resolved closure and executable — under this directory. `None` leaves it to `[records] dir` and `OCX_RECORDS_DIR`; with none of the three, no record is written.
- `records_name` (`str | None`) (default: `None`) — The record's filename template, over `{time}`, `{host}`, `{pid}` and `{rand}`. `None` leaves it to `[records] name` and `OCX_RECORDS_NAME`.
- `capture` (`bool`) (default: `True`) — Pipe and capture both streams.
- `check` (`bool`) (default: `True`) — Raise on a non-zero child exit instead of returning it.
- `timeout` (`MaybeTimeout`) (default: `UNSET`) — Seconds for the whole run. Omitted takes the config's.

**Returns**

- (`CommandResult`) — The child's exit code and, under `capture`, its output.

**Raises**

- `ValueError` — `argv` is empty.
- `OcxProcessError` — The child exited non-zero under `check`.
- `OcxTimeoutError` — The timeout expired.

[View source](https://github.com/ocx-sh/ocx-sdk-python/blob/main/src/ocx_sdk/_client.py#L1644-L1695)