ocx-sh/Setup OCX
Install the OCX package manager and (optionally) activate an OCX project from ocx.toml + ocx.lock
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| version | OCX version to install (e.g., "latest", "0.2.0") | no | latest |
| github-token | GitHub token for API requests and release downloads | no | ${{ github.token }} |
| libc | Linux C library variant ("gnu" or "musl"). Auto-detected if not specified. | no | "" |
| project | Path to the project ocx.toml (relative to working-directory). Set to an empty string to disable project auto-load. When the file exists, the action runs `ocx pull` and activates the project so subsequent steps can invoke the bound tools directly. | no | ocx.toml |
| working-directory | Directory used to resolve `project` and to invoke ocx. Defaults to the workflow workspace. | no | ${{ github.workspace }} |
| groups | Comma-separated list of project groups to pre-warm via `ocx pull -g`. Empty (default) pulls every entry from ocx.lock. | no | "" |
| cache | Cache the OCX object store ($OCX_HOME/{blobs,layers,packages,tags}) across runs via @actions/cache, keyed on a hash of ocx.lock. Also caches the ocx binary itself. | no | true |
| cache-suffix | Extra string appended to cache keys for manual cache busting. | no | "" |
| ocx-home | Overrides $OCX_HOME. Defaults to ~/.ocx. | no | "" |
Outputs
| name | description |
|---|---|
| version | The installed OCX version |
| ocx-path | Path to the OCX binary directory |
| cache-hit | Whether the OCX binary was restored from cache |
| project-loaded | Whether an OCX project was found and activated (`"true"` / `"false"`) |
| project-cache-hit | Whether the OCX object store was restored from the cache for this project |