Eve Read Docs (Load First)

Purpose: provide a compact, public, always-available distillation of Eve Horizon system docs. Use this when private system docs are not accessible.

When to Use

• Any question about how to use Eve Horizon via CLI or API.
• Any question about .eve/manifest.yaml, pipelines, workflows, jobs, or secrets.
• Any question about events, triggers, agents, teams, builds, or deployments.

How to Use

1. Start with references/overview.md for core concepts, IDs, and the reference index.
2. Use the task router below to choose the smallest set of references for the request.
3. Open only the relevant reference files and avoid loading unrelated docs.
4. Ask for missing project or environment inputs before giving prescriptive commands.

Task Router (Progressive Access)

• Platform orientation, environment URLs, and architecture: references/overview.md
• Command syntax, flags, and CLI workflows: references/cli.md
• Fine-grained CLI intents:
  • references/cli-auth.md (auth + access + policy)
  • references/cli-org-project.md (init, org/project setup, docs, fs sync)
  • references/cli-jobs.md (jobs and execution controls)
  • references/cli-pipelines.md (builds, releases, pipelines, workflows)
  • references/cli-deploy-debug.md (deploy, recovery, local stack, CLI troubleshooting)
• Manifest authoring and config structure: references/manifest.md
• Pipelines, workflows, triggers, and event-driven automation: references/pipelines-workflows.md + references/events.md
• Job lifecycle, scheduling, and execution debugging: references/jobs.md
• Build, release, and deployment behavior: references/builds-releases.md + references/deploy-debug.md
• Agents, teams, and chat routing: references/agents-teams.md + references/gateways.md
• Secrets, auth, access control, and identity providers: references/secrets-auth.md
• Skills installation, packs, and resolution order: references/skills-system.md
• Harness selection and sandbox policy: references/harnesses.md
• Object store, org filesystem sync, share tokens, and public paths: references/object-store-filesystem.md
• Document ingestion (upload, processing, download, callbacks): references/ingest.md
• Eve SDK overview, install, quick-start, token flow, exports: references/eve-sdk.md
• Auth SDK deep-dive, @eve-horizon/auth, @eve-horizon/auth-react, app SSO middleware, token verification: references/auth-sdk.md
• Build agent-friendly CLIs for app APIs, manifest declaration, bundling, distribution, env var contract: references/app-cli.md
• OAuth app credentials (BYOA), Google Drive mounts, cloud FS browse/search, integrations, Slack connect, GitHub setup, identity linking, membership requests: references/integrations.md
• Observability, cost tracking, receipts, and analytics: references/observability.md
• Database provisioning, migrations, SQL, and managed DB operations: references/database-ops.md
• Symptom-first troubleshooting across auth, secrets, deploy, jobs, and builds: references/troubleshooting.md

Index

• references/overview.md -- Architecture, core concepts, IDs, job phases, reference index.
• references/cli.md -- CLI quick reference: all commands by category with flags and options.
• references/manifest.md -- Manifest v2 spec: services, environments, pipelines, workflows, x-eve extensions.
• references/events.md -- Event type catalog (all sources + payloads) and trigger syntax (github, slack, system, cron, manual).
• references/jobs.md -- Job lifecycle, phases, CLI, git/workspace controls, scheduling hints.
• references/builds-releases.md -- Build system (specs, runs, artifacts), releases, deploy model, promotion patterns.
• references/agents-teams.md -- Agent/team/chat YAML schemas, sync flow, slug rules, dispatch modes, coordination threads.
• references/pipelines-workflows.md -- Pipeline steps, triggers, workflow invocation, build-release-deploy pattern.
• references/secrets-auth.md -- Secrets scopes, interpolation, auth model, identity providers, OAuth sync, service principals, access visibility, custom roles, policy-as-code.
• references/skills-system.md -- Skills format, skills.txt, install flow, discovery priority.
• references/deploy-debug.md -- K8s architecture, worker images, deploy polling, ingress/TLS, secrets provisioning, workspace janitor, CLI debugging workflows, real-time debugging, env-specific debugging.
• references/harnesses.md -- Harness selection, profiles, auth priority, sandbox flags.
• references/gateways.md -- Gateway plugin architecture, Slack + Nostr providers, thread keys.
• references/cli-auth.md -- CLI auth, service accounts, access roles, and policy-as-code.
• references/cli-org-project.md -- CLI commands for org/project setup, docs, FS sync, and resolver URIs.
• references/cli-jobs.md -- CLI job lifecycle: create/list/update, attempt tracking, result/monitoring/attachments.
• references/cli-pipelines.md -- CLI build/release/pipeline/workflow command reference.
• references/cli-deploy-debug.md -- CLI environment deploy/recover/lifecycle and local k3d stack.
• references/object-store-filesystem.md -- Object store, org filesystem sync protocol, share tokens, public paths, app buckets, access control.
• references/ingest.md -- Document ingest lifecycle: upload, processing, download URLs, callbacks, CORS, event integration.
• references/eve-sdk.md -- Eve SDK overview: packages, install, quick-start patterns, token flow, backend/frontend exports, environment variables.
• references/auth-sdk.md -- Eve Auth SDK deep-dive: middleware behavior, verification strategies, token types, SSO session bootstrap, NestJS patterns, migration guide.
• references/integrations.md -- OAuth app credentials (BYOA), Google Drive cloud FS mounts, external integrations (Slack, GitHub), identity resolution tiers, membership requests, CLI linking.
• references/observability.md -- Correlation IDs, execution receipts, cost tracking, analytics, OTEL config, provider discovery.
• references/database-ops.md -- Managed DB provisioning, migrations, SQL access, schema/RLS inspection, scaling/reset/destroy.
• references/app-cli.md -- App CLI framework: manifest declaration, env var contract, bundling, distribution, implementation patterns.
• references/troubleshooting.md -- Symptom-first diagnostic tables for auth, secrets, deploy, jobs, builds, network issues.

Intent Coverage Matrix

Hard Rules

• Eve is API-first; the CLI only needs EVE_API_URL.
• Do not assume URLs, ports, or environment state--ask if unknown.
• These references describe shipped platform behavior only.
• If anything is missing or unclear, ask for the missing inputs.