eve-bootstrap

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Eve Bootstrap

One skill that handles everything from zero to a working Eve project. It detects whether you're already authenticated and adapts:

Already authenticated → skips to project setup
Not authenticated → creates profile, requests access, waits for admin approval, auto-logs in, then sets up project

一款能让你从零搭建起可运行的Eve项目的skill。它会检测你是否已完成认证，并做出相应适配：

已认证 → 直接跳转到项目设置环节
未认证 → 创建个人资料，申请访问权限，等待管理员审批，自动登录，然后设置项目

Step 1: Check CLI

步骤1：检查CLI

bash

eve --version

If this fails, install the CLI first:

bash

npm install -g @eve-horizon/cli@0.2.73

bash

eve --version

如果该命令执行失败，请先安装CLI：

bash

npm install -g @eve-horizon/cli@0.2.73

Step 2: Create Profile

步骤2：创建个人资料

Check if a profile already exists:

bash

eve profile list

If no

staging

profile exists, create one:

bash

eve profile create staging --api-url https://api.eve.example.com
eve profile use staging

检查是否已存在个人资料：

bash

eve profile list

如果不存在

staging

个人资料，请创建一个：

bash

eve profile create staging --api-url https://api.eve.example.com
eve profile use staging

Step 3: Check Auth Status

步骤3：检查认证状态

bash

eve auth status

This calls the API — not a local file check. Two outcomes:

bash

eve auth status

该命令会调用API——并非检查本地文件。有两种结果：

Already authenticated → go to Step 5

已认证 → 跳转至步骤5

eve auth status

shows you're logged in, skip ahead to Step 5: Project Setup.

如果

eve auth status

显示你已登录，请直接跳至步骤5：项目设置。

Not authenticated → continue to Step 4

未认证 → 继续步骤4

Step 4: Request Access (New Users Only)

步骤4：申请访问权限（仅新用户）

Find an SSH public key to use:

bash

ls ~/.ssh/*.pub

Default:

~/.ssh/id_ed25519.pub

. If no key exists, generate one:

bash

ssh-keygen -t ed25519 -f ~/.ssh/id_ed25519

Ask the user for:

Org name — what they want to call their organisation
Email — optional, for their user account

Submit the access request and wait for approval:

bash

eve auth request-access \
  --ssh-key ~/.ssh/id_ed25519.pub \
  --org "My Company" \
  --email user@example.com \
  --wait

The

--wait

flag:

Submits the request (unauthenticated)
Prints the request ID (
```
areq_xxx
```
)
Polls every 5 seconds until an admin approves or rejects
On approval: auto-completes SSH challenge login
Stores token in
```
~/.eve/credentials.json
```

Tell the user: "An admin needs to run

eve admin access-requests approve <id>

to approve your request."

Once approved, you're logged in with your own org (as admin).

找到要使用的SSH公钥：

bash

ls ~/.ssh/*.pub

默认路径：

~/.ssh/id_ed25519.pub

。如果不存在密钥，请生成一个：

bash

ssh-keygen -t ed25519 -f ~/.ssh/id_ed25519

向用户收集以下信息：

组织名称 —— 用户想要为其组织设置的名称
邮箱 —— 可选，用于用户账户

提交访问请求并等待审批：

bash

eve auth request-access \
  --ssh-key ~/.ssh/id_ed25519.pub \
  --org "My Company" \
  --email user@example.com \
  --wait

--wait

参数的作用：

提交请求（未认证状态下）
打印请求ID（格式为
```
areq_xxx
```
）
每5秒轮询一次，直到管理员批准或拒绝请求
审批通过后：自动完成SSH挑战登录
将令牌存储在
```
~/.eve/credentials.json
```
中

告知用户：“管理员需要执行

eve admin access-requests approve <id>

来批准你的请求。”

审批通过后，你将以所在组织管理员的身份登录。

Step 5: Project Setup

步骤5：项目设置

Set profile defaults if org/project IDs are known:

bash

eve profile set --org <org_id> --project <proj_id>

If no project exists yet, ask the user for:

Project name and slug (slug is immutable, keep it short)
Repo URL (e.g.,
```
git@github.com:org/repo.git
```
)

bash

undefined

如果已知组织/项目ID，设置个人资料默认值：

bash

eve profile set --org <org_id> --project <proj_id>

如果尚未创建项目，请向用户收集以下信息：

项目名称和别名（slug）（别名不可修改，请保持简短）
仓库URL（例如：
```
git@github.com:org/repo.git
```
）

bash

undefined

Option A: Ensure project exists

选项A：确保项目已存在

eve project ensure --name "My App" --slug myapp
--repo-url git@github.com:org/repo.git --branch main

Option B: Bootstrap project + environments in one call

选项B：一键初始化项目及环境

eve project bootstrap --name "My App" --repo-url git@github.com:org/repo.git
--environments staging,production


**URL impact:** Slugs determine deployment URLs:
`{service}.{orgSlug}-{projectSlug}-{env}.{domain}`

eve project bootstrap --name "My App" --repo-url git@github.com:org/repo.git
--environments staging,production


**URL影响：** 别名会决定部署URL的格式：
`{service}.{orgSlug}-{projectSlug}-{env}.{domain}`

Step 6: Manifest

步骤6：清单文件（Manifest）

.eve/manifest.yaml

doesn't exist, create a minimal one:

yaml

schema: eve/compose/v2
project: myapp

registry: "eve"

services:
  web:
    build:
      context: .
      dockerfile: Dockerfile
    # image is optional; Eve derives it from the service name when managed registry is used
    ports: [3000]
    x-eve:
      ingress:
        public: true
        port: 3000

environments:
  staging:
    pipeline: deploy

pipelines:
  deploy:
    steps:
      - name: build
        action: { type: build }
      - name: release
        depends_on: [build]
        action: { type: release }
      - name: deploy
        depends_on: [release]
        action: { type: deploy }

Use the

eve-manifest-authoring

skill for detailed manifest guidance.

如果

.eve/manifest.yaml

不存在，请创建一个最简版本：

yaml

schema: eve/compose/v2
project: myapp

registry: "eve"

services:
  web:
    build:
      context: .
      dockerfile: Dockerfile
    # image为可选参数；使用托管镜像仓库时，Eve会根据服务名称自动推导
    ports: [3000]
    x-eve:
      ingress:
        public: true
        port: 3000

environments:
  staging:
    pipeline: deploy

pipelines:
  deploy:
    steps:
      - name: build
        action: { type: build }
      - name: release
        depends_on: [build]
        action: { type: release }
      - name: deploy
        depends_on: [release]
        action: { type: deploy }

如需详细的清单文件编写指导，请使用

eve-manifest-authoring

skill。

Step 7: Learn the Platform

步骤7：了解平台

Read the Eve platform reference to understand all capabilities:

https://showcase.eve.example.com/llms

This covers CLI commands, manifest syntax, agent harnesses, job lifecycle, and more.

阅读Eve平台参考文档，了解所有功能：

https://showcase.eve.example.com/llms

文档涵盖CLI命令、清单文件语法、Agent harnesses、任务生命周期等内容。

Step 8: Verify

步骤8：验证

bash

eve auth status
eve system health
eve project list

bash

eve auth status
eve system health
eve project list

Summary

总结

Print what was set up:

Profile: name, API URL
Auth: email, org name, org slug
Project: name, slug, repo URL

Next steps: sync manifest (

eve project sync

), deploy (

eve env deploy staging --ref main --repo-dir .

)

打印已完成的设置内容：

个人资料：名称、API URL
认证信息：邮箱、组织名称、组织别名
项目：名称、别名、仓库URL

下一步操作：同步清单文件（

eve project sync

）、部署（

eve env deploy staging --ref main --repo-dir .

）