Docs CloudCopy Anchor Link

Docs Cloud is the hosted layer around @farming-labs/docs. Your repository stays the source of truth, your docs app still owns the runtime, and Cloud adds managed deploys, analytics, publish workflows, and agent operations around it.

The Cloud contract has three parts:

• docs.config.ts stays the executable config for the docs runtime.
• docs.json is the serializable project contract that Cloud can read.
• Docs Cloud owns hosted services such as deploys, analytics storage, and publish workflows.

Cloud SectionsCopy Anchor Link

Minimal ConfigCopy Anchor Link

Add a cloud block when the project should participate in Cloud-aware CLI flows:

import { defineDocs } from "@farming-labs/docs";

export default defineDocs({
  entry: "docs",
  cloud: {
    apiKey: { env: "DOCS_CLOUD_API_KEY" },
    deploy: { enabled: true },
    publish: { mode: "draft-pr", baseBranch: "main" },
  },
});

cloud.apiKey.env names the environment variable that stores the project API key. The raw key stays outside source control.

Sync The ContractCopy Anchor Link

Run cloud sync to write the serializable Cloud contract:

pnpm dlx @farming-labs/docs cloud sync

docs.json is safe to commit because it contains configuration and environment variable names, not secret values.

Check Before DeployCopy Anchor Link

Run a read-only check when you want to validate Cloud wiring without creating a preview:

pnpm dlx @farming-labs/docs cloud check

Use --analytics, --ask-ai, or --deploy when you only want to validate one part of the Cloud setup. The check reports stale docs.json, missing project/API key env vars, hosted API reachability, and CORS issues before you spend time on a deploy.

Next StepCopy Anchor Link

Use the deploy page for the full preview flow:

pnpm dlx @farming-labs/docs deploy

See Deploy for API key setup, command options, preview behavior, publish mode, and troubleshooting.

Related DocsCopy Anchor Link

• Deploy covers hosted preview deployments.
• Analytics covers Cloud-managed analytics storage.
• docs.json explains the repo-level contract that Cloud reads.
• Configuration lists the cloud config fields.
• CLI covers the full command surface.
• Cloud landing page explains the managed product direction and waitlist.