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
- Start with
references/overview.mdfor core concepts, IDs, and the reference index. - Use the task router below to choose the smallest set of references for the request.
- Open only the relevant reference files and avoid loading unrelated docs.
- 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 (includes cloud-fs, endpoint, and ingest commands):
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, config structure, app CLI framework, toolchain declarations, cloud FS mounts, per-org OAuth, and app undeploy/delete:
references/manifest.md - Pipelines, workflows, triggers, event-driven automation, auto-trigger, event/app triggers, workflow input forwarding, step optimization, and per-step
with_apis:references/pipelines-workflows.md+references/events.md - Job lifecycle, scheduling, execution debugging, agent-native monitoring, production hardening, and per-job HOME isolation:
references/jobs.md - Build, release, and deployment behavior:
references/builds-releases.md+references/deploy-debug.md - Private endpoints (Tailscale), worker toolchain-on-demand, and app undeploy/delete:
references/deploy-debug.md - Agents, teams, chat routing, agent aliases, staged dispatch, chat delivery, and chat progress:
references/agents-teams.md+references/gateways.md - Secrets, auth, access control, identity providers, BYOK model credentials, and per-org OAuth credential storage:
references/secrets-auth.md - Skills installation, packs, and resolution order:
references/skills-system.md - Harness selection, sandbox policy, BYOK model setup, shared invoke, toolchain-on-demand, and chat harness profiles:
references/harnesses.md - Object store, org filesystem sync, share tokens, public paths, GCS storage, and cloud FS (Google Drive):
references/object-store-filesystem.md - Document ingestion (upload, processing, download, callbacks):
references/ingest.md - Document ingestion pipeline (end-to-end flow, agentpack, media processing, chat files):
references/document-ingestion.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, project role resolution, and org awareness: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, Slack install smoothing, gateway hot-load, per-org OAuth, chat file materialization, integrations, Slack connect, GitHub setup, identity linking, membership requests:
references/integrations.md - Observability, request diagnostics, service logs, traces, 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 - LLM Wiki pattern, wiki-maintaining agents, knowledge base architecture, near-instant indexing:
references/llm-wiki.md
Index
references/overview.md-- Architecture, core concepts, IDs, job phases, BYOK inference, document ingestion, cloud FS, private endpoints, reference index.references/cli.md-- CLI quick reference: all commands by category with flags and options, including cloud-fs, endpoint, and ingest commands.references/manifest.md-- Manifest v2 spec: services, environments, pipelines, workflows, x-eve extensions, app CLI framework, toolchain declarations, cloud FS mounts, per-org OAuth, app undeploy/delete.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, agent-native monitoring, production hardening, per-job HOME isolation.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, agent aliases, staged team dispatch, chat outbound delivery, chat progress updates, dispatch modes, coordination threads.references/pipelines-workflows.md-- Pipeline steps, triggers, workflow invocation, auto-trigger, event/app triggers, workflow input forwarding, step optimization, per-stepwith_apis, 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, BYOK model credentials, per-org OAuth credential storage.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, private endpoints (Tailscale), worker toolchain-on-demand, app undeploy/delete, CLI debugging workflows, real-time debugging, env-specific debugging.references/harnesses.md-- Harness selection, profiles, auth priority, sandbox flags, BYOK model setup, shared invoke module, toolchain-on-demand, harness profiles for chat.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, native GCS storage, cloud FS (Google Drive mounts).references/ingest.md-- Document ingest lifecycle: upload, processing, download URLs, callbacks, CORS, event integration.references/document-ingestion.md-- Document ingestion pipeline: end-to-end flow, ingest:// URI scheme, agentpack, media processing (ffmpeg + whisper), chat file materialization, integration points.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, project role resolution, org awareness, migration guide.references/integrations.md-- OAuth app credentials (BYOA), Google Drive cloud FS mounts, Slack install smoothing, gateway hot-load, per-org OAuth, chat file materialization, external integrations (Slack, GitHub), identity resolution tiers, membership requests, CLI linking.references/observability.md-- Correlation IDs, app service logs, request diagnostics, traces, 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.references/llm-wiki.md-- LLM Wiki pattern: two-layer substrate, agent workflow, near-instant indexing, operations (ingest/query/lint/bulk), relationship to Company as Intelligence.
Intent Coverage Matrix
| Intent | Minimum references | Expected output |
|---|---|---|
| Authenticate or inspect permissions | references/cli-auth.md, references/secrets-auth.md | Session state, token/permission validation result |
| Bootstrap org/project resources | references/cli-org-project.md, references/manifest.md | Org/project IDs, members, manifest sync status |
| Submit and monitor work | references/cli-jobs.md, references/jobs.md | Job IDs, phase transitions, attempt logs |
| Build/deploy a version | references/cli-pipelines.md, references/builds-releases.md, references/pipelines-workflows.md | Pipeline run ID, build/release artifacts, deployment trace |
| Recover from runtime issues | references/cli-deploy-debug.md, references/deploy-debug.md, references/cli-jobs.md | Diagnose output, recovery target, mitigation command plan |
| Trace a deployed app request | references/observability.md, references/cli-deploy-debug.md, references/deploy-debug.md | Request logs, deploy metadata, K8s events, audit rows, trace spans |
| Inspect platform behavior or events | references/events.md, references/agents-teams.md | Canonical event stream view, routing path |
| Install/update skills for agents | references/skills-system.md, references/overview.md | Installed pack/skill set and resolution order |
| Monitor costs, receipts, or analytics | references/observability.md, references/cli.md | Receipt breakdown, analytics counters, cost totals |
| Provision or operate environment databases | references/database-ops.md, references/manifest.md | Migration status, query results, managed DB state |
| Sync files, share links, or configure org filesystem | references/object-store-filesystem.md, references/cli-org-project.md | Sync status, share tokens, public path URLs |
| Upload, process, or download documents via ingest | references/ingest.md, references/document-ingestion.md, references/events.md | Ingest IDs, download URLs, callback payloads, processing status |
| Configure ingest agentpack or media processing | references/document-ingestion.md, references/agents-teams.md | Pack import, profile selection, media tool availability |
| Understand how Slack files reach agents | references/document-ingestion.md, references/gateways.md | Chat file flow, attachment index, workspace layout |
| Add SSO auth to an app or verify tokens | references/eve-sdk.md, references/auth-sdk.md, references/secrets-auth.md | SDK setup code, token verification, SSO flow |
| Configure OAuth app credentials or connect Google Drive | references/integrations.md | BYOA config status, mount IDs, browse/search results |
| Connect Slack/GitHub or resolve external identities | references/integrations.md, references/agents-teams.md | Integration status, identity binding, membership requests |
| Build an agent-friendly CLI for an app API | references/app-cli.md, references/manifest.md | CLI source, esbuild bundle, manifest declaration, tested commands |
| Connect Google Drive or browse cloud FS | references/object-store-filesystem.md, references/integrations.md | Mount ID, browse/search results, cloud FS event triggers |
| Set up private endpoints (Tailscale) | references/deploy-debug.md, references/cli.md | Endpoint name, in-cluster DNS, health check status |
| Declare or use toolchains | references/manifest.md, references/harnesses.md | Toolchain list, init container config, PATH setup |
| Set up agent aliases or vanity names | references/agents-teams.md | Alias binding, slug resolution, sync validation |
| Check chat delivery status or progress | references/agents-teams.md, references/gateways.md | Delivery status, thread messages, progress updates |
| Configure event or app triggers for workflows | references/pipelines-workflows.md, references/events.md | Trigger config, event payload forwarding, matched workflow |
| Undeploy or delete an app/environment | references/deploy-debug.md, references/manifest.md | Deploy status, cleanup sequence, cascade-delete |
| Configure BYOK model credentials | references/secrets-auth.md, references/harnesses.md | Secret scope, harness env mapping, provider key |
| Set up per-org OAuth credentials (BYOA) | references/integrations.md, references/manifest.md | OAuth app config, provider connection, credential storage |
| Configure GCS native storage | references/object-store-filesystem.md | Storage backend config, Workload Identity binding |
| Monitor jobs with agent-native tooling | references/jobs.md, references/cli-jobs.md | Job status, monitoring output, production safeguards |
| Set up staged team dispatch (council) | references/agents-teams.md | Team config, staged flag, lead/member coordination |
Configure per-step with_apis in workflows | references/pipelines-workflows.md, references/manifest.md | Step overrides, API injection, workflow-level defaults |
| Resolve project roles in auth SDK | references/auth-sdk.md, references/secrets-auth.md | Project role claim, X-Eve-Project-Id header, middleware config |
| Configure custom domains for deployed apps | references/cli.md, references/manifest.md, references/deploy-debug.md | Domain registration, DNS verification, TLS activation |
| Diagnose a failure from symptoms | references/troubleshooting.md, references/deploy-debug.md | Root cause, fix command, recovery path |
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.