edgeone 1.1.0 → 1.1.2

package/README.md

@@ -80,7 +80,7 @@ fetch('/api/my-functions', {
 
 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 start count limit. Avoid frequently stopping and restarting the dev service. Hot reloads do not increase the count.
+- 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
 
@@ -89,40 +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:
 
-```plaintext
-edgeone pages deploy <directoryOrZip> -n <projectName>
-```
+### 6. Deploy
 
-Starting from version v1.1.0, direct deployment within the project is supported:
+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 -n <projectName>
+edgeone pages deploy [<directoryOrZip>] [-n <projectName>] [-e <env>]
 ```
-The CLI will automatically build and initiate deployment based on the project configuration.
 
 #### 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:
-- If you specify a deploy folder (e.g., `dist`), you need to manually copy the `node-functions` and/or `edge-functions` folders, as well as your project's `package.json`, into that folder before running `deploy`.
-- If you do not specify a deploy folder, the CLI will automatically bundle your frontend code and function code into the `.edgeone` directory, from which you can deploy using the `deploy` command.
+- 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**
@@ -148,28 +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> [-e <env>]
+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:
-- If you specify a deploy folder (e.g., `dist`), you need to manually copy the `node-functions` and/or `edge-functions` folders, as well as your project's `package.json`, into that folder before running `deploy`.
-- If you do not specify a deploy folder, the CLI will automatically bundle your frontend code and function code into the `.edgeone` directory, from which you can deploy using the `deploy` command.
+- 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
@@ -182,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)._