Skip to content

Getting Started

kadubon edited this page Aug 25, 2026 · 1 revision

Getting Started

A safe first session

CPCF's default installation is offline-capable. It supports CPython 3.12–3.14 on Windows and Linux (Python 3.14.0 and 3.14.1 are excluded). Install the public package with one of the following:

pip install collective-phase-control-fabric
pipx install collective-phase-control-fabric
pip install "collective-phase-control-fabric[server,solver]"

The optional extras add service integrations, a worker, runner support, bounded Z3 analysis, or KMS clients. They do not change the basic claim boundary.

Inspect without credentials

The following commands do not require an API endpoint, a token, or network access:

cpcf agent explain --json
cpcf self-check --json
cpcf schema list --json
cpcf schema show phase-contract --json

They answer different questions:

Command Purpose
agent explain Prints the system's claim boundary.
self-check Checks the supported Python range and the runtime schema registry.
schema list Lists the closed document models that runtime validation recognizes.
schema show phase-contract Displays one specific schema.

Verify a portable bundle

cpcf bundle verify CPCF_BUNDLE --json
cpcf bundle verify CPCF_BUNDLE --trust-policy TRUST_POLICY.json --json

The first command checks content consistency: whether the bundle's declared objects and digests agree. That is not the same as authentic distribution provenance. Without an admitted root attestation and an applicable trust policy, authenticity remains unknown, even if all object digests match.

Before moving to a remote workspace

Read Evidence and Authority and Remote Workspaces. Remote operations can change control-plane state and require both a configured endpoint and a short-lived OIDC access token. Do not place credentials, live endpoints, tenant evidence, or signed production records in issue text or public documentation.

Next reading

Clone this wiki locally