EdgeOne Pages

https://pages.edgeone.ai/zh/document
Admin
EdgeOne Pages is a full-stack development and deployment platform built on Tencent EdgeOne...
Tokens:281,065
Snippets:1,958
Trust Score:9.7
Update:1 week ago
Show doc for...
Tokens:
Raw
### Install dependencies and start dev server

Source: https://pages.edgeone.ai/zh/document/frontends-vue

After creating the project, enter the project directory, install dependencies, and run the development server. This starts the Vite dev server with hot module replacement.

```bash
cd my-vue-app
npm install
npm run dev
```

--------------------------------

### Install @edgeone/tanstack-start adapter

Source: https://pages.edgeone.ai/zh/document/framework-tanstack-start

Install the EdgeOne Makers adapter for TanStack Start. Run this in your project root before configuring Vite.

```bash
npm install @edgeone/tanstack-start
```

--------------------------------

### Start React app with npm start

Source: https://pages.edgeone.ai/zh/document/frontends-react

Navigates into the project directory and starts the development server with live reloading.

```bash
cd my-react-app
npm start
```

--------------------------------

### FastAPI framework example: index.py

Source: https://pages.edgeone.ai/zh/document/python

Advanced example using FastAPI. Place this file in ./cloud-functions/api/index.py. Demonstrates defining GET and POST endpoints with path parameters.

```python
# ./cloud-functions/api/index.py
from fastapi import FastAPI

app = FastAPI()

@app.get('/items')
async def list_items():
    return {'items': [{'id': 1, 'name': 'Item A'}, {'id': 2, 'name': 'Item B'}]}

@app.get('/items/{item_id}')
async def get_item(item_id: int):
    return {'item_id': item_id, 'name': f'Item {item_id}'}

@app.post('/items')
async def create_item(item: dict):
    return {'message': 'Item created', 'item': item}
```

--------------------------------

### Deploy button with example repository URL

Source: https://pages.edgeone.ai/zh/document/deploy-button

Example with a real repository URL, showing how to encode the URL and include a subpath (e.g., /tree/main/examples/vue-template).

```markdown
[![使用 EdgeOne Makers 部署](https://cdnstatic.tencentcs.com/edgeone/pages/deploy.svg)](https://edgeone.ai/pages/new?repository-url=https%3A%2F%2Fgithub.com%2FTencentEdgeOne%2Fpages-templates%2Ftree%2Fmain%2Fexamples%2Fvue-template)
```

--------------------------------

### Example Templates

Source: https://pages.edgeone.ai/zh/document/edge-functions

Provides example templates for common use cases: getting user geolocation, using KV storage to record page visits, and connecting to a Supabase database.

```APIDOC
## Example Templates

### Description
Example templates for common Edge Functions use cases.

### Get User Geolocation

Use `context.request.eo` to get client GEO information.

### Use KV to Record Page Visits

Refer to the KV storage documentation for details on using KV storage.

### Connect to Supabase Database

Example for connecting to a Supabase third-party database.
```

--------------------------------

### Start local preview server with hexo server

Source: https://pages.edgeone.ai/zh/document/wordpress-integration

Starts the Hexo local preview server. After running, visit http://localhost:4000 to preview the site.

```bash
hexo server
```

--------------------------------

### Install @edgeone/astro adapter

Source: https://pages.edgeone.ai/zh/document/framework-astro

Installs the Makers Astro adapter package.

```bash
npm install @edgeone/astro
```

--------------------------------

### Installation (pip)

Source: https://pages.edgeone.ai/zh/document/sdk-overview

Install the EdgeOne Makers SDK for Python using pip. Requires Python 3.10+.

```APIDOC
## Install SDK (pip)

### Description
Install the EdgeOne Makers SDK for Python using pip.

### Command
```bash
pip install makers-sdk
```

### Requirements
- Python 3.10+
```

--------------------------------

### Example go.mod File

Source: https://pages.edgeone.ai/zh/document/go

Shows a sample go.mod file with module name, Go version, and required dependencies.

```go
module my-project
  

go 1.26
  

require (
    github.com/gin-gonic/gin v1.10.0
)
```

--------------------------------

### Install Dependencies and Start Gatsby

Source: https://pages.edgeone.ai/zh/document/woocommerce-integration

Install npm dependencies and start the Gatsby development server with EdgeOne Makers, ensuring fePort matches Gatsby's port for cross-origin authentication.

```bash
npm install
gatsby develop && edgeone makers dev --fePort=8000
```

--------------------------------

### get usage examples

Source: https://pages.edgeone.ai/zh/document/kv-storage

Examples of using the get method with different type specifications. The first returns a string, the second uses a string type argument, and the third uses an object with a type property.

```javascript
let value = await my_kv.get(key);
let value = await my_kv.get(key, "json");
let value = await my_kv.get(key, {type: "json"});
```

--------------------------------

### Run Local Development Server

Source: https://pages.edgeone.ai/zh/document/contentful-integration

Starts the local development server to preview the website.

```bash
npm run dev
```

--------------------------------

### Complete example: track page visits with KV

Source: https://pages.edgeone.ai/zh/document/kv-storage

A complete example of a Makers Function that uses the KV namespace my_kv to track page visit counts. It gets the current count, increments it, and puts the new value back, then returns a response.

```javascript
export async function onRequest({ request, params, env }) {
    // 获取变量名为 my_kv 的命名空间 key
    let count = await my_kv.get("count");
    count = Number(count) + 1;
    
    // 重新写入 visitCount 键值
    await my_kv.put("count", String(count));

    return new Response("ok", {});
}
```

--------------------------------

### Deploy button with URL search parameters

Source: https://pages.edgeone.ai/zh/document/deploy-button

Example using URL search parameters to set output-directory, install-command, and build-command. Parameter values must be encoded with encodeURIComponent().

```markdown
[![使用 EdgeOne Makers 部署](https://cdnstatic.tencentcs.com/edgeone/pages/deploy.svg)](https://edgeone.ai/pages/new?repository-url=https%3A%2F%2Fgithub.com%2FTencentEdgeOne%2Fpages-templates%2Ftree%2Fmain%2Fexamples%2Fvue-template&output-directory=.%2Fdist&install-command=npm%20install&build-command=npm%20run%20build)
```

--------------------------------

### Get a single deployment with deployments.get (Python)

Source: https://pages.edgeone.ai/zh/document/sdk-deployment

Fetches a single deployment by project ID and deployment ID. Throws NotFoundError if the deployment does not exist. The example prints status and env.

```python
deployment = makers.deployments.get(
    project_id="your-project-id",
    deployment_id="your-deployment-id",
)

print(deployment["status"], deployment["env"])
```

--------------------------------

### edgeone.json full example

Source: https://pages.edgeone.ai/zh/document/edgeone-json

A comprehensive example combining multiple settings: name, build/install commands, output directory, node version, redirects, rewrites, headers, and cloudFunctions configuration. Not all settings are required.

```json
{
  "name": "example-app",
  "buildCommand": "next build",
  "installCommand": "npm install",
  "outputDirectory": "./build",
  "nodeVersion": "22.11.0",
  "redirects": [
    {
      "source": "/articles/:id",
      "destination": "/news-articles/:id",
      "statusCode": 301
    },
    {
      "source": "/old-path",
      "destination": "/new-path",
      "statusCode": 302
    }
  ],
  "rewrites": [
    {
      "source": "/assets/*",
      "destination": "/assets-new/:splat"
    }
  ],
  "headers": [
    {
      "source": "/*",
      "headers": [
        {
          "key": "X-Frame-Options",
          "value": "DENY"
        },
        {
          "key": "Cache-Control",
          "value": "max-age=7200"
        }
      ]
    },
    {
      "source": "/assets/*",
      "headers": [
        {
          "key": "Cache-Control",
          "value": "max-age=31536000"
        }
      ]
    }
  ],
  "cloudFunctions": {
    "mainlandRegions": ["ap-guangzhou"],
    "nodejs": {
      "externalNodeModules": [
        "svg-captcha"
      ], 
      "includeFiles": [
        "assets/**"
      ],
      "maxDuration": 60
    }
  }
}
```

--------------------------------

### Get a single deployment with deployments.get (TypeScript)

Source: https://pages.edgeone.ai/zh/document/sdk-deployment

Fetches a single deployment by project ID and deployment ID. Throws NotFoundError if the deployment does not exist. The example prints status and env.

```typescript
const deployment = await makers.deployments.get({
  projectId: "your-project-id",
  deploymentId: "your-deployment-id",
});

console.log(deployment.status, deployment.env);
```

--------------------------------

### 克隆 Supabase Auth Starter 仓库

Source: https://pages.edgeone.ai/zh/document/authentication-supabase-integration

从GitHub克隆项目代码并进入项目目录。将${your-github-account}替换为您的GitHub账户名。

```bash
git clone https://github.com/${your-github-account}/supabase-auth-starter
cd supabase-auth-starter
```

--------------------------------

### deployments.list Python example

Source: https://pages.edgeone.ai/zh/document/sdk-deployment

Paginates through deployments of a project. Page starts at 0, page_size default 20 (max 100). Returns a dict with items, page, page_size, total, has_next. Order field uses 'created_on' or 'modified_on'.

```python
page = makers.deployments.list(
    project_id="your-project-id",
    page=0,
    page_size=20,
    order={"field": "created_on", "direction": "desc"},
)

print(page["total"], page["has_next"])
for deployment in page["items"]:
    print(deployment["deployment_id"], deployment["status"])
```

--------------------------------

### deployments.list TypeScript example

Source: https://pages.edgeone.ai/zh/document/sdk-deployment

Paginates through deployments of a project. Page starts at 0, pageSize default 20 (max 100). Returns a Page object with items, page, pageSize, total, hasNext. Order field uses 'createdOn' or 'modifiedOn'.

```typescript
const page = await makers.deployments.list({
  projectId: "your-project-id",
  page: 0,
  pageSize: 20,
  order: { field: "createdOn", direction: "desc" },
});

console.log(page.total, page.hasNext);
for (const deployment of page.items) {
  console.log(deployment.deploymentId, deployment.status);
}
```

--------------------------------

### Basic deployment with files artifact (Python)

Source: https://pages.edgeone.ai/zh/document/sdk-deployment

Python equivalent of the basic deployment example. Uses snake_case parameters and returns a dict with deployment_id and env.

```python
deployment = makers.deployments.deploy(
    project_id="your-project-id",
    artifact={"files": {"index.html": "<h1>Hello</h1>"}},
)

print(deployment["deployment_id"], deployment["env"])
```

--------------------------------

### Install project dependencies with npm install

Source: https://pages.edgeone.ai/zh/document/wordpress-integration

Installs the required npm dependencies for the Hexo-based template. Requires Node.js 14.0+ and npm 6.0+.

```bash
# 安装依赖
npm install
```

--------------------------------

### Initialize Go Module

Source: https://pages.edgeone.ai/zh/document/go

Commands to create a go.mod file in the cloud-functions directory.

```bash
cd cloud-functions
go mod init my-project
```

--------------------------------

### Framework 模式源码目录结构

Source: https://pages.edgeone.ai/zh/document/building-output-configuration

Framework 模式下源码目录结构，入口文件为 api.go。

```text
cloud-functions/
├── api.go
├── go.mod
└── go.sum
```

--------------------------------

### Install Contentful CLI

Source: https://pages.edgeone.ai/zh/document/contentful-integration

Globally installs the Contentful CLI tool using npm.

```bash
npm install -g contentful-cli
```

--------------------------------

### context.tools.toClaudeMcpServer(name?, options?)

Source: https://pages.edgeone.ai/zh/document/sandbox-using-the-agent-framework

Converts sandbox built-in tools into a Claude Agent SDK MCP server bundle. The returned bundle can be passed to createSdkMcpServer or create_sdk_mcp_server for registration.

```APIDOC
## context.tools.toClaudeMcpServer(name?, options?)

### Description
Converts sandbox built-in tools into a Claude Agent SDK MCP server bundle. The returned bundle can be passed to createSdkMcpServer or create_sdk_mcp_server for registration.

### Method
Function call

### Endpoint
context.tools.toClaudeMcpServer(name?, options?)

### Parameters
- **name** (string) - Optional - MCP server name, will be synced as `mcp__<name>__<tool>` prefix.
- **options.alwaysLoad** / **options.always_load** (boolean) - Optional - Default marks `anthropic/alwaysLoad`; pass { alwaysLoad: false } to not write `anthropic/alwaysLoad` metadata.

### Return Value
Returns an MCP bundle object.

### Request Example
```ts
import { createSdkMcpServer } from '@anthropic-ai/claude-agent-sdk'
export async function onRequest(context: any) {
  const edgeoneMcp = context.tools.toClaudeMcpServer()
  // 自定义 server name
  const customMcp = context.tools.toClaudeMcpServer('sandbox')
  const mcpServers = [
    createSdkMcpServer({
      name: edgeoneMcp.name,
      tools: edgeoneMcp.tools,
    }),
  ]
  const allowedTools = edgeoneMcp.allowedTools
  // 将 mcpServers / allowedTools 传给 Claude Agent SDK
}
```

### Response Example
```python
from claude_agent_sdk import create_sdk_mcp_server
async def handler(ctx):
    edgeone_mcp = ctx.tools.to_claude_mcp_server()
    # 自定义 server name
    # custom_mcp = ctx.tools.to_claude_mcp_server('sandbox')
    mcp_servers = [
        create_sdk_mcp_server(
            name=edgeone_mcp.name,
            tools=edgeone_mcp.tools,
        )
    ]
    allowed_tools = edgeone_mcp.allowed_tools
    # 将 mcp_servers / allowed_tools 传给 Claude Agent SDK
```
```

--------------------------------

### onRequestGet

Source: https://pages.edgeone.ai/zh/document/node-functions

Handles HTTP GET requests. Use this to respond to GET requests specifically.

```APIDOC
## onRequestGet

### Description
Handles HTTP GET requests. Use this to respond to GET requests specifically.

### Method
GET

### Endpoint
Any path under the functions directory.

### Parameters
#### Path Parameters
- **params** (object) - Optional - Dynamic route parameters.

#### Query Parameters
- **searchParams** (URLSearchParams) - Optional - Access via `new URL(context.request.url).searchParams`.

### Request Example
```
GET /api/users
```

### Response
#### Success Response (200)
- **body** (string) - The response content.
- **headers** (object) - Response headers.

#### Response Example
```
{"users":[]}
```
```

--------------------------------

### installCommand 配置示例

Source: https://pages.edgeone.ai/zh/document/edgeone-json

覆盖控制台中的安装命令，可自定义构建过程使用的包管理器。

```json
{
    "installCommand": "npm install"
}
```

--------------------------------

### Deploy with Tenant Token (JavaScript and Python)

Source: https://pages.edgeone.ai/zh/document/sdk-creating-a-deployment

Uses a platform-level Makers API Token to create a tenant token (expiring in 86400 seconds) for the tenant ID 'user-open-id', then deploys with that tenant token while isolating platform credentials. The tenant token is used to create a project and deploy a file artifact, reducing risk of API Token leakage.

```javascript
import { Makers } from "@edgeone/makers-sdk";

const platform = new Makers({
  token: process.env.MAKERS_API_TOKEN,
  region: "china",
});

const { token, tokenId, expired } = await platform.tokens.create({
  tenantId: "user-open-id",
  name: "user-open-id",
  expiresIn: 86400,
});

const user = new Makers({
  token,
  region: "china",
});

const { projectId } = await user.projects.create({ name: "my-site" });
await user.deployments.deploy({
  projectId,
  artifact: { files: { "index.html": "<h1>Hello</h1>" } },
});
```

```python
import os

from makers_sdk import Makers

platform = Makers(
    token=os.environ["MAKERS_API_TOKEN"],
    region="china",
)

created = platform.tokens.create(
    tenant_id="user-open-id",
    name="user-open-id",
    expires_in=86400,
)

user = Makers(
    token=created["token"],
    region="china",
)

project = user.projects.create(name="my-site")
user.deployments.deploy(
    project_id=project["project_id"],
    artifact={"files": {"index.html": "<h1>Hello</h1>"}},
)
```

--------------------------------

### delete usage example

Source: https://pages.edgeone.ai/zh/document/kv-storage

Example of using the delete method to remove a key-value pair.

```javascript
await my_kv.delete(key);
```

--------------------------------

### Deploy button for specific branch

Source: https://pages.edgeone.ai/zh/document/deploy-button

Example for deploying a specific branch. Append /tree/branch-name to the repository URL.

```markdown
[![使用 EdgeOne Makers 部署](https://cdnstatic.tencentcs.com/edgeone/pages/deploy.svg)](https://edgeone.ai/pages/new?repository-url=https%3A%2F%2Fgithub.com%2Fusername%2Frepository%2Ftree%2Fbranch-name)
```

--------------------------------

### Handler 模式构建输出目录结构

Source: https://pages.edgeone.ai/zh/document/building-output-configuration

Handler 模式构建输出目录结构，入口文件固定为 main.go。

```text
cloud-functions/api-go
├── config.json
├── go.mod
└── main.go // handler 模式下输出产物入口文件文件名固定为 main
```

--------------------------------

### Add Go Dependencies with go get

Source: https://pages.edgeone.ai/zh/document/go

Commands to add third-party dependencies using go get.

```bash
go get github.com/gin-gonic/gin
go get github.com/go-chi/chi/v5
```
Tokens:
Raw