Install with an AI agent
On this page you’ll get a task brief you can hand to a terminal-capable AI agent. The agent installs Cortrix v1.0.0-rc.2 on your machine, verifies it, and returns a structured report.
This path runs the same loopback-only Docker flow as the Quickstart. It’s a local first-value setup, not an internet-facing, cloud, security, or production deployment procedure.
Prerequisites
The AI agent needs to be able to use your local filesystem, Git, Docker, Docker Compose, and curl. It can be a coding assistant or a broader agent runtime. Whether it qualifies depends on those capabilities. This page doesn’t claim that every version or configuration of any particular product has been validated.
Contract identity
Both the release tag and the full commit it resolves to must be recorded. A checkout of the mutable main branch doesn’t satisfy this contract.
What the agent may do
- Inspect local prerequisites: Git, Docker, Docker Compose,
curl, disk, network, and ports. - Create one new installation directory.
- Clone the declared repository and check out the declared release.
- Build and start the documented Docker Compose stack.
- Download the pinned model files that stack needs.
- Call the readiness and query endpoints on the loopback address.
- Leave the verified local service running.
- Report the files, containers, volumes, and commands it used.
What the agent must not do
- Modify, reset, delete, or reuse an existing Cortrix checkout.
- Use
sudoor install system-level dependencies without separate approval from you. - Request, read, store, or invent keys for LLM, cloud, GitHub, or any other service.
- Change firewall, DNS, proxy, VPN, or system security settings.
- Publish Cortrix on
0.0.0.0or any non-loopback address. - Turn off ONNX, embedding, reranking, model checksums, readiness, or source verification to make the run pass.
- Delete existing Docker images, containers, caches, or volumes.
- Run
docker compose down --volumesunless you explicitly ask for it. - Describe this contract as a production deployment or as production readiness.
Copyable agent task
Give your AI agent this brief exactly as written. It’s contract text, so don’t reword it:
Required execution path
The agent must create a new cortrix directory under a parent directory you approve. If cortrix already exists there, it must stop rather than overwrite or reuse it.
The first start downloads about 1.17 GB of pinned model files and can take several minutes. No .env file, provider key, host-side model tooling, manual model download or conversion, or separate bootstrap command is required.
Required verification
Readiness:
A source-backed reranked query:
The result must contain content from quickstart-demo.txt and a numeric rerank_score. A process that exits successfully without those two assertions is still a failed contract.
Required final report
PASS requires all of these: the exact repository and release, the 40-character commit that the tag resolves to, a loopback-only bind, readiness, source content, numeric rerank scores, external LLM roles left off, and a running service.
Failure behavior
The agent must stop and return FAIL when:
- A prerequisite is missing.
- The target directory already exists.
- The tag or commit doesn’t match what was expected.
- The API port is in use.
- The Docker build, a download, an integrity check, startup, or readiness fails.
- The query fails or lacks the required source content.
rerank_scoreis absent or isn’t numeric.- The service binds beyond the loopback address.
- Finishing the task would require a prohibited action.
The report must preserve the original error and name the next decision you need to make. The agent must not quietly switch to a different build profile or to weaker verification.
Stop or reset
After you’ve reviewed the report, you can ask the agent to stop the service:
Removing the cached models and local data is a separate, destructive decision that’s yours to make:
The agent must not run the cleanup command with --volumes unless you explicitly ask for it.
What this path doesn’t verify
An agent-assisted install doesn’t verify every HTTP API, parser, the built-in Agent, MCP, the SDK, authentication, tenants, security, benchmarks, or production behavior. Before you expand the deployment, read Compatibility and status and Choose an access path.
Next steps
- Quickstart: run the same flow yourself.
- Choose an access path
- Compatibility and status