edgeone 1.0.34 → 1.1.1

package/README.md

@@ -56,7 +56,7 @@ After successful login, execute the initialization command to initialize the bas
 edgeone pages init
 ```
 
-After initialization, a `functions` folder and sample functions will be generated in the root directory of the project. You can continue to add and develop functions in this folder.
+After initialization, an `edge-functions` or `node-functions` folder and sample functions will be generated in the root directory of the project. You can continue to add and develop functions in this folder.
 
 ### 4. Local Development
 
@@ -66,35 +66,22 @@ After completing initialization, enter the local development stage:
 edgeone pages dev
 ```
 
-Executing the command will start a service on the local port 8088 by default. You can access the sample function via `http://localhost:8088/helloworld`. Here, the access path is the address path of the function file in the `functions` folder.
+Executing the command will start a service on the local port 8088 by default. The Pages Functions service and the Pages project run on the same port.
 
-During local development, the service for Pages Functions and the service for the Pages project may run on different ports. In order to allow the Pages project to call functions, you can use a proxy server or reverse proxy to forward requests to the correct port. Here is an example configuration of webpack-dev-server:
-
-```javascript
-module.exports = {
-  devServer: {
-    proxy: {
-      '/api': {
-        target: 'http://localhost:8088', // Local Development Service Address for Pages Function
-        chagneOrigin: true,
-        pathRewrite: {
-          '^/api': '',
-        },
-      },
-    },
-  },
-};
-```
-
-In this way, use the Fetch API in the Pages project:
+Visit the frontend at `http://localhost:8088/`, and call your functions directly using their file paths under `edge-functions` or `node-functions`.
 
 ```javascript
+// ./node-functions/api/my-functions.js
 fetch('/api/my-functions', {
   method: 'POST',
   body: JSON.stringify({ data: 'example' }),
 });
 ```
 
+Note:
+- The dev service will read `devCommand` from `edgeone.json` to start your dev server. If absent, it will read the `dev` script from your project's `package.json`.
+- Edge Functions debug service has a limit on the number of times it can start up, so try to avoid frequently logging out and starting the dev service (hot updates within the dev service will not increase the startup count).
+
 ### 5. Associated Project
 
 If you need to use the Key-Value Storage capability or synchronize the environment variables set in the console to local debugging, you can execute the Associated Project commands, enter the project name as required. The project name here is the one created in the Preparation Work of the Pages project.
@@ -102,29 +89,35 @@ If you need to use the Key-Value Storage capability or synchronize the environme
 ```plaintext
 edgeone pages link
 ```
+If you need to link a project that does not exist, you can also create a new project directly under the CLI guide.
+
 
 ### 6. Deploy
 
-After local development and debugging are completed, you can deploy your project directly using the deploy command:
+If your project is created via "direct upload", you can also deploy it directly to the Pages platform locally by executing the following command:
 
 ```plaintext
-edgeone pages deploy <directoryOrZip> -n <projectName>
+edgeone pages deploy [<directoryOrZip>] [-n <projectName>] [-e <env>]
 ```
 
 #### Parameters
 
-- `<directoryOrZip>`: Path of folder or ZIP package to deploy (required)
-- `-n, --name`: Project name for deployment (creates new or updates existing project) (required)
+- `<directoryOrZip>`: Path of folder or ZIP package to deploy
+- `-n, --name`: Project name for deployment (creates new or updates existing project)
 - `-e, --env`: Environment to deploy to, choices: 'production' or 'preview' (default: 'production')
 
+Note:
+- By default, when executing deploy, the CLI will automatically build and package frontend code, `node-functions`, and `edge-functions` into the `.edgeone` folder and deploy to Pages.
+- If you choose to manually build the project, you need to copy the related folders of Pages Functions and the project's `package.json` file to dist (suppose the output directory is dist) after building, then rerun `edgeone pages deploy ./dist`.
+
 #### Usage Examples
 
 ```plaintext
 # Deploy build folder to production
-edgeone pages deploy ./dist -n edgeone-pages-project
+edgeone pages deploy
 
 # Deploy ZIP package to preview environment
-edgeone pages deploy ./build.zip -n edgeone-pages-project -e preview
+edgeone pages deploy -e preview
 ```
 
 **Alternative: Git-based Deployment**
@@ -139,26 +132,6 @@ If you need to switch to another Tencent Cloud account, you can execute the foll
 edgeone switch
 ```
 
-### 8. Combine with front end
-
-EdgeOne Pages CLI supports local development and debugging of EdgeOne Pages functions. If your project contains frontend code, you need to manually start the corresponding development service.
-
-For frontend applications that need to access local functions, currently you need to distinguish function access paths through environment variables in your frontend code:
-
-```
-// when start dev server
-ENV=dev npm run build
-
-//In your code
-const REQUEST_API = process.env.ENV === 'dev' ? 'https://localhost:8088/' : '/'
-```
-
-For functions involving cross-origin validation scenarios like login and authentication, you can specify the `--fePort` parameter when starting the development server.
-
-```
-edgeone pages dev --fePort=8000 // your front dev server port
-```
-
 <br/>
 
 ## 3. CI/CD Integration
@@ -170,24 +143,28 @@ This section provides guidance on integrating EdgeOne CLI into your CI/CD pipeli
 For CI/CD pipelines, you can use the same deploy command with an API Token for authentication:
 
 ```plaintext
-edgeone pages deploy <directoryOrZip> -n <projectName> -t <token>
+edgeone pages deploy [<directoryOrZip>] -n <projectName> -t <token> [-e <env>]
 ```
 
 #### Parameters
 
-- `<directoryOrZip>`: Path of folder or ZIP package to deploy (required)
+- `<directoryOrZip>`: Path of folder or ZIP package to deploy
 - `-n, --name`: Project name for deployment (creates new or updates existing project) (required)
 - `-e, --env`: Environment to deploy to, choices: 'production' or 'preview' (default: 'production')
 - `-t, --token`: API Token for CI/CD pipelines (required for automated deployments)
 
+Note:
+- By default, when executing deploy, the CLI will automatically build and package frontend code, `node-functions`, and `edge-functions` into the `.edgeone` folder and deploy to Pages.
+- If you choose to manually build the project, you need to copy the related folders of Pages Functions and the project's `package.json` file to dist (suppose the output directory is dist) after building, then rerun `edgeone pages deploy ./dist`.
+
 #### CI/CD Pipeline Examples
 
 ```plaintext
 # Basic CI deployment to production with API token
-edgeone pages deploy ./dist -n edgeone-pages-project -t $EDGEONE_API_TOKEN
+edgeone pages deploy -n edgeone-pages-project -t $EDGEONE_API_TOKEN
 
 # CI deployment to preview environment with API token
-edgeone pages deploy ./build.zip -n edgeone-pages-project -e preview -t $EDGEONE_API_TOKEN
+edgeone pages deploy -n edgeone-pages-project -e preview -t $EDGEONE_API_TOKEN
 ```
 
 #### Obtaining an API Token
@@ -200,13 +177,13 @@ How to create an API Token
 4. Select "expiration time" to ensure your information security.
 5. Click Submit.
 
-For more information, please refer to https://edgeone.ai/document/177158578324279296
+For more information, please refer to https://pages.edgeone.ai/document/api-token
 
 <br/>
 
 ## References
 
-[Pages Introduction](https://edgeone.ai/document/160427672992178176) ｜ [Pages Functions](https://edgeone.ai/document/162227908259442688)
+[Pages Introduction](https://pages.edgeone.ai/document/product-introduction) ｜ [Pages Functions](https://pages.edgeone.ai/document/pages-functions-overview)
 
 _To access the China site documentation, please click [here](https://edgeone.cloud.tencent.com/pages/document/162936635171454976)._
 
@@ -214,4 +191,4 @@ _To access the China site documentation, please click [here](https://edgeone.clo
 
 ## Contact
 
-If you need technical support, please [contact us](https://edgeone.ai/contact?source=edgeone-cli).
+If you need technical support, please [contact us](https://edgeone.ai/contact?source=edgeone-cli).