EdgeOne

https://edgeone.ai/document
Admin
EdgeOne is a platform offering edge acceleration for efficient content delivery, comprehensive edge...
Tokens:1,507,137
Snippets:8,824
Trust Score:9.7
Update:6 days ago
Show doc for...
Tokens:
Raw
### Example success summary output

Source: https://edgeone.ai/document/80200

Example output the AI may produce after installation, showing the CLI path, installation location, and file verification.

```text
Completed:
- The check revealed that the skillhub CLI was not previously installed.
- The "CLI-only installation" has been performed according to https://skillhub.cn/install/skillhub.md:
  - CLI path: /Users/sowawu/.local/bin/skillhub
- The tencent-edgeone skill has been installed:
  - Installation location: /Users/sowawu/.codebuddy/plugins/marketplaces/git_github_com_Tencent_tencent_edgeone_agent_plugins_git/skills/tencent-edgeone
- The file existence has been verified:
  - skills/tencent-edgeone/SKILL.md

```

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

### Local Debugging: Setup Commands

Source: https://edgeone.ai/document/213782821217427456

Commands to clone the repository, install dependencies, configure environment variables, and start the development server with 'edgeone makers dev'.

```bash
# Clone your repository.
git clone https://github.com/your-username/ai-assistant.git
cd ai-assistant

# Install dependencies.
npm install

# Configure environment variables.
cp .env.example .env
# Edit the .env file and populate it with AI_GATEWAY_API_KEY and other variables.

# Start the development server.
edgeone makers dev
```

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

### Enter project and start development server

Source: https://edgeone.ai/document/196763737788014592

After creating the project, navigate into the project directory, install dependencies, and start the development server with these commands.

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

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

### deployments.deploy Python example

Source: https://edgeone.ai/document/220119149487783936

Starts a deployment with the specified artifact. By default, it does not wait for completion and returns immediately with only deployment_id, project_id, and env. The example prints the deployment ID and environment.

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

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

### Terraform version output example

Source: https://edgeone.ai/document/51433

Example output from the terraform -version command, indicating successful installation.

```text
> Terraform v1.0.10
> on darwin_amd64
> Your version of Terraform is out of date! The latest version
> is 1.1.0. You can update by downloading from https://www.terraform.io/downloads.html
```

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

### Install Dependencies and Start Local Development

Source: https://edgeone.ai/document/178279639901777920

Commands to install dependencies and start the Gatsby development server with EdgeOne Makers, ensuring the fePort matches Gatsby's port for cross-domain authentication.

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

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

### Deploy Button with URL Search Parameters

Source: https://edgeone.ai/document/173005746548674560

Example deploy button using URL search parameters to set output directory, install command, and build command. Parameters must be URL-encoded.

```markdown
[![Deploy with 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)
```

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

### deployments.deploy TypeScript example

Source: https://edgeone.ai/document/220119149487783936

Starts a deployment with the specified artifact. By default, it does not wait for completion and returns immediately with only deploymentId, projectId, and env. The example logs the deployment ID and environment.

```typescript
const deployment = await makers.deployments.deploy({
  projectId: "your-project-id",
  artifact: { files: { "index.html": "<h1>Hello</h1>" } },
});
  
console.log(deployment.deploymentId, deployment.env);
```

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

### Start React development server

Source: https://edgeone.ai/document/196763685510774784

Enter the project directory and start the development server with npm start.

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

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

### Local deployment examples

Source: https://edgeone.ai/document/162228053922476032

Examples for deploying to production (default) and preview environments. The `-e preview` flag targets the preview environment.

```bash
# Production environment deployment
edgeone makers deploy
```

```bash
# Preview environment deployment
edgeone makers deploy -e preview
```

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

### Install @edgeone/tanstack-start adapter

Source: https://edgeone.ai/document/201258022376095744

Install the EdgeOne Makers adapter for TanStack Start using npm. This is the first step to deploy a TanStack Start project on Makers.

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

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

### get usage examples

Source: https://edgeone.ai/document/162227803822321664

Examples of calling the get method with different type specifications: default text, string type, and object type. The Promise must be awaited to retrieve the value.

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

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

### Start Local Preview Server with hexo server

Source: https://edgeone.ai/document/177813016598880256

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

```bash
hexo server
```

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

### Deploy and Wait for Preview URL (Python)

Source: https://edgeone.ai/document/220213607563350016

Creates a project, deploys it, and then waits for the deployment to complete. If the status is 'Success', prints the preview URL; otherwise prints the status. Handles MakersError by printing an error message.

```python
import os
from makers_sdk import Makers, MakersError
  

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

def deploy_and_wait():
    try:
        created = makers.projects.create(name="my-site")
        project_id = created["project_id"]
  

        deployment = makers.deployments.deploy(
            project_id=project_id,
            artifact={"files": {"index.html": "<h1>Hello</h1>"}},
        )
  

        result = makers.deployments.wait(
            project_id=project_id,
            deployment_id=deployment["deployment_id"],
        )
  

        if result.get("status") == "Success":
            print(result.get("preview_url"))
        else:
            print(result.get("status"))
    except MakersError as error:
        print(f"Error: {error}")
  

deploy_and_wait()
```

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

### Add Third-Party Dependencies with go get

Source: https://edgeone.ai/document/204373855432982528

Commands to add third-party dependencies using go get. Examples include gin and chi.

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

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

### FastAPI Framework Example

Source: https://edgeone.ai/document/205713904659333120

Use the FastAPI framework to create a RESTful API. This example defines endpoints for listing items, getting a specific item, and creating an item.

```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}
```

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

### Check Keyless server startup log

Source: https://edgeone.ai/document/65286

Tails the log file to verify the service has launched successfully.

```bash
tail -f log/keyless.log
```

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

### go.mod Example

Source: https://edgeone.ai/document/204373855432982528

Example go.mod file showing module name, Go version, and required dependencies.

```go
module my-project

go 1.26

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

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

### CreatePlanForZone Output Example

Source: https://edgeone.ai/document/50546

Example response from the CreatePlanForZone API. Contains the RequestId, ResourceNames, and DealNames fields.

```json
{
    "Response": {
        "RequestId": "a06f52e7-2aab-4510-b2c2-1065bfb4414c",
        "ResourceNames": [
            "plan_sta"
        ],
        "DealNames": [
            "2022080135400110011001"
        ]
    }
}
```

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

### HTTP GET request structure for DescribeInstances

Source: https://edgeone.ai/document/50457

Example of an HTTP GET request to query the CVM instance list. The request URL includes the common parameters and the signature. The request headers include Host and Content-Type.

```http
https://cvm.tencentcloudapi.com/?Action=DescribeInstances&Version=2017-03-12&SignatureMethod=HmacSHA256&Timestamp=1527672334&Signature=37ac2f4fde00b0ac9bd9eadeb459b1bbee224158d66e7ae5fcadb70b2d181d02&Region=ap-guangzhou&Nonce=23823223&SecretId=AKID********************************

Host: cvm.tencentcloudapi.com
Content-Type: application/x-www-form-urlencoded
```

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

### Clone and navigate to the AI SDK image generator starter template

Source: https://edgeone.ai/document/184786907382796288

Commands to clone the template repository from your GitHub account and navigate into the project directory. Replace ${your-github-account} with your actual GitHub username.

```bash
git clone https://github.com/${your-github-account}/ai-sdk-image-generator-starter.git
cd ai-sdk-image-generator
```

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

### Example: onRequest handler using KV

Source: https://edgeone.ai/document/162227803822321664

Complete example of an onRequest handler that reads a count from KV, increments it, writes it back, and returns a response. Demonstrates using get and put with the my_kv namespace variable.

```typescript
export async function onRequest({ request, params, env }) {
    // get the namespace key with variable name my_kv
    let count = await my_kv.get("count");
    count = Number(count) + 1;
    
    // rewrite the visitCount key-value
    await my_kv.put("count", String(count));
  

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

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

### Clone the ai-sdk-chatbot-starter template from GitHub

Source: https://edgeone.ai/document/184787238051311616

Use these commands to download the generated project from your GitHub account to your local machine. Replace [your_github_account] with your actual GitHub username.

```bash
git clone https://github.com/[your_github_account]/vercel-ai-sdk-chatbot.git
cd vercel-ai-sdk-chatbot

```

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

### HTTP GET request structure for DescribeInstances

Source: https://edgeone.ai/document/50457

Example of an HTTP GET request to query the CVM instance list in the Guangzhou region. The request URL includes query parameters Limit=10 and Offset=0, and the required headers include the Authorization header with the TC3-HMAC-SHA256 signature.

```http
https://cvm.tencentcloudapi.com/?Limit=10&Offset=0

Authorization: TC3-HMAC-SHA256 Credential=AKID********************************/2018-10-09/cvm/tc3_request, SignedHeaders=content-type;host, Signature=5da7a33f6993f0614b047e5df4582db9e9bf4672ba50567dba16c6ccf174c474
Content-Type: application/x-www-form-urlencoded
Host: cvm.tencentcloudapi.com
X-TC-Action: DescribeInstances
X-TC-Version: 2017-03-12
X-TC-Timestamp: 1539084154
X-TC-Region: ap-guangzhou
```
Tokens:
Raw