Skip to content
OPTOPHI QUICKSTART · DEVELOPMENT PREVIEW

Start in your project.
Keep the work yours.

The intended entry point is optophi init. Add project guidance, work with your coding agent on native files, and review the checks before authorizing a trial.

Public Optophi installation is not available yet. The current local candidate requires a reviewed wheel and explicit setup options. No hosted account is required for local setup.

01 / PREPARE THE PREVIEW

Use a reviewed local candidate.

Preview access is for reviewers with the exact artifact and its trusted source/hash record. There is no public Optophi registry install command to copy yet. The local CLI requires Python 3.11+; the current status checks require a supported POSIX host.

Installation for reviewers who already have the wheel

Verify the artifact against its review record first. Replace the absolute wheel path below with that reviewed file. These POSIX-shell commands create an isolated tool environment; current candidate qualification covers Linux.

python3 -m venv .optophi-tools
source .optophi-tools/bin/activate
python -m pip install --no-index --no-deps /absolute/path/to/reviewed/optophi_onboarding-0.0.0.dev0-py3-none-any.whl
Accepted platform candidate record (repository access required)

Canonical build, installation and plugin-export guide. The CLI and coding-client integrations are maintained in Optophi platform, independently of this website.

02 / INITIALIZE

Preview guidance before applying.

From your existing repository, use the installed development candidate with explicit file references. The current CLI does not provide the full interactive setup shown by the intended journey.

optophi init --project . --manager pip --client codex \
  --pipeline pipelines/company_profiles/pipeline-postgres.yaml \
  --contract pipelines/company_profiles/source-contract.yaml \
  --contract pipelines/company_profiles/contract.yaml

Review the generated guidance and plan ID. To apply, repeat the exact command with --apply --expect-plan and that reviewed ID. A declined preview leaves the project unchanged. Native pipeline and contract files remain yours to author and review.

03 / DESCRIBE AND REVIEW

Ask the essential questions first.

Ask your coding agent to read the active repository instructions and .optophi/guidance.md. Agree on source authority, symbols, keys, units, update window, reject policy and destination before reviewing native file changes.

Prepare an FMP company-profile pipeline for PostgreSQL.
Ask me about the symbols, update window, keys,
currency and reject policy before drafting.
Use synthetic inputs for the first reviewed trial.

This is an example prompt, not a recording of a completed agent session. The existing plugin can be separately previewed/exported and enabled with explicit client consent. Setup does not prove the agent discovered or followed it.

Inspect the controlled recipe source (repository access may be required)
04 / VERIFY AND APPROVE

Check configuration. Bound the trial.

The native runtime is a separate prerequisite. Select the exact supported runtime/profile, review the complete files and their local references, then use its supported checks from the recipe directory.

The controlled PostgreSQL profile identifies a separate development wheel and host, not the public 0.0.67 validation-only environment. Review its exact artifact hashes and limits (repository access required).

python -m pycharter.cli pipeline validate pipeline-postgres.yaml
python -m pycharter.cli pipeline inspect pipeline-postgres.yaml

The FMP-to-PostgreSQL recipe is a controlled synthetic development profile. Live FMP response authority and access are not qualified by it. Validation or manifest inspection is not proof of execution or destination publication. A real trial needs explicit approval, limits and independently checked destination rows.

Review scheduled and cloud operation separately
OPTIONAL / HOSTED SERVICE

Use hosted validation when you need it.

Hosted API-key access is a separate service path, not a local-onboarding prerequisite. Existing provisioned keys are bound to a tool profile; self-service account availability follows the configured hosted service.

Transport: Streamable HTTP
URL: https://api.optophi.com/mcp
Authorization: Bearer <your-optophi-tool-key>

The currently qualified hosted task validates bounded record batches over REST/MCP. It does not establish an FMP pipeline deployment. Keep your key in the selected client's supported credential mechanism.

Hosted account and API-key access
Feedback