eve-read-eve-docs

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, architecture, Eve Dashboard, system app pattern: references/overview.md
• Command syntax, flags, and CLI workflows (includes cloud-fs, endpoint, ingest, traces, env logs --follow/--filter, env diagnose --request, eve tcp-ingress test, eve app-links, eve admin email bounces list [--recipient|--event-type|--limit|--json], eve org invite --project --redirect-to, eve project auth-context 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, per-job harness/env overrides, app-link injection via --with-links, scoped job tokens via jobs.token_scope)
  • references/cli-pipelines.md (builds, releases, pipelines, workflows)
  • references/cli-deploy-debug.md (deploy, recovery, local stack, CLI troubleshooting, env logs follow/filter, env diagnose --request, traces query)
• Manifest authoring, config structure, app CLI framework, cross-project app links (x-eve.app_links), toolchain declarations, cloud FS mounts, per-org OAuth, app undeploy/delete, custom domains, public TCP ingress (x-eve.tcp_ingress), stable egress (hostNetwork v2), workflow env_overrides + conditional steps + step-level harness/harness_options + step git controls + retry tails + file refs + Slack notifications + resource ref policies, manifest-driven service token permissions, x-eve.branding (logo/color/From-name), x-eve.auth.login_method (magic_link), x-eve.auth.self_signup, x-eve.auth.invite_requires_password, x-eve.auth.org_access, x-eve.auth.domain_signup v2 rule list ([{domain, target_org, role}]), x-eve.auth.allowed_redirect_origins, jobs.token_scope axes (orgfs/orgdocs/envdb/cloud_fs): references/manifest.md
• Pipelines, workflows, triggers, event-driven automation, auto-trigger, event/app/app_link triggers, workflow input forwarding, step optimization, per-step with_apis, workflow env_overrides + conditional steps + step-level harness + retry-failed + file refs + Slack notifications, event→trigger observability (trigger_match_count, triggers_evaluated), scoped job tokens (workflow/step/invocation scope intersection into jobs.token_scope): references/pipelines-workflows.md + references/events.md
• Job lifecycle, scheduling, execution debugging, agent-native monitoring, production hardening, per-job HOME isolation, per-job harness/env overrides, app-link env/CLI injection, learning loop (system.job.attempt.completed, carryover context), stuck-job prevention + stale recovery + env-gate scope, scoped job tokens (jobs.token_scope axes: orgfs/orgdocs/envdb/cloud_fs): references/jobs.md
• Build, release, and deployment behavior: references/builds-releases.md + references/deploy-debug.md
• Private endpoints (Tailscale), worker toolchain-on-demand, app undeploy/delete, custom domains debugging (first-bind-wins, cert-manager TLS, eve domain list|verify|status|transfer|unbind|remove), public TCP ingress diagnostics, stable egress (hostNetwork v2), DeployFailure taxonomy + cluster snapshot + manifest_hash from deploy ref + eve env diagnose, Platform Sentinel (env health monitoring + Slack alerts): references/deploy-debug.md
• Agents, teams, chat routing, embedded app conversations, agent aliases, staged dispatch, chat delivery, chat progress, structured conversation event streams (cevt_*), chat continuity by Eve thr_* id, chat regex case-insensitive, agent learning loop hooks, agent-runtime org auto-discovery (no org_default): references/agents-teams.md + references/gateways.md
• Secrets, auth, access control, identity providers, BYOK model credentials, per-org OAuth credential storage, manifest-driven service token permissions + auto-injected EVE_SERVICE_TOKEN (read-only defaults), app-link tokens (type: app_link), SSO self-signup email domain restriction (EVE_SIGNUP_ALLOWED_EMAIL_DOMAINS), per-agent envdb wildcard scope (built-in roles), app magic-link login opt-in (x-eve.auth.login_method: magic_link), magic-link confirmation interstitial (wrap tokens; prevents drive-by scanner redemption), domain-signup v2 rule list ([{domain, target_org, role}]), project-scoped redirect allowlist (x-eve.auth.allowed_redirect_origins), platform-guaranteed SameSite=None on eve_sso session cookies for custom-domain apps: references/secrets-auth.md
• Skills installation, packs, resolution order, materialization fast-path + .agents/skills/ canonicalization + sparse pack support + eve skills materialize runtime path: references/skills-system.md
• Harness selection, sandbox policy, BYOK model setup, shared invoke, toolchain-on-demand, chat harness profiles, per-job harness override (--harness-override-file) + env override (--env-override), harness-profile-validation endpoint, chat hint propagation, Phase 4 step-template expressions, Codex reasoning + harness model normalization, Opus 4.7 + GPT-5.5 model registrations: references/harnesses.md
• Object store, org filesystem sync, share tokens, public paths, GCS storage, cloud FS (Google Drive), app bucket credential separation: 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, doc.ingest workflow trigger reliability fixes): references/document-ingestion.md
• Eve SDK overview, install, quick-start, token flow, embedded conversations, chat SDKs, exports, structured conversation event streams, chat continuity by thr_* id, branded app login pattern, useEveAppAccess(), in-app admin invites via POST /auth/app-invites: 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, magic-link login SDK opt-in, domain-signup v2 SDK behavior, magic-link confirmation interstitial transparency to EveAuthProvider: 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, API chat provider (no-op for polling clients; 4 built-in providers: slack, nostr, webchat, api), app org access + in-app admin invites (POST /auth/app-invites, eve org invite --project --redirect-to, eve project auth-context), app-branded invite + magic-link emails (logo, color, From-name via x-eve.branding), project-scoped redirect allowlist: references/integrations.md + references/gateways.md
• Observability, request diagnostics, service logs (eve env logs --follow, --filter k=v), traces (eve traces query), eve env diagnose --request <req_id>, cost tracking, receipts, analytics, event→trigger observability (trigger_match_count, triggers_evaluated, eve event show), SES mailer reliability (pre-flight suppression check, bounce webhook, email_delivery_events table, eve admin email bounces list [--recipient|--event-type|--limit|--json]): references/observability.md
• Database provisioning, migrations, SQL, managed DB operations, managed DB TLS trust (verify-full default + CA bundle injection): references/database-ops.md
• Symptom-first troubleshooting across auth, secrets, deploy, jobs, builds, DeployFailure taxonomy + diagnose, Platform Sentinel alert interpretation, stuck-job prevention + stale recovery, SES drops (suppression / bounces / email_delivery_events), missing magic-link or invite emails, magic-link confirmation interstitial expectations, custom-domain SameSite=None cookies, redirect allowlist mismatches, scoped job token denials, domain-signup v2 migration: references/troubleshooting.md
• LLM Wiki pattern, wiki-maintaining agents, knowledge base architecture, near-instant indexing, CLI enhancements (eve docs patch, diff, watch, sync, list --tree, search --path/--context, bulk-write): references/llm-wiki.md