esa-cli 0.0.5 → 1.0.0

package/dist/docs/Commands_en.md

@@ -1,224 +1,271 @@
-# Commands
+## Commands
 
-### init
+### esa-cli init [name]
+
+Initialize a project with a template or a framework.
 
-Initialize a routine with a template.
-    
 ```bash
-$ esa init [OPTIONS]
+esa-cli init [name]
 ```
 
-- -c, --config `boolean` `optional`
-- Generate a config file for your project.
+- Positionals:
+  - name: Project name
+
+- Options:
+  - -f, --framework string: Choose a frontend framework (react/vue/nextjs...)
+  - -l, --language string: Choose programming language (typescript/javascript). Choices: typescript | javascript
+  - -t, --template string: Template name to use
+  - -y, --yes boolean: Answer "Yes" to all prompts (default: false)
+  - --git boolean: Initialize git repository
+  - --deploy boolean: Deploy after initialization
 
-### routine [script]
+---
 
-Manage your routine.
-    
-#### delete <routineName>
+### esa-cli dev [entry]
 
-Delete a routine.
+Start a local server for developing your project.
 
 ```bash
-$ esa routine delete <routineName>
+esa-cli dev [entry]
 ```
 
-- routineName `string` `required`
-- The name of the routine to delete.
+- Positionals:
+  - entry: Entry file of Functions& Pages
+
+- Options:
+  - -p, --port number: Port to listen on
+  - -m, --minify boolean: Minify code during development (default: false)
+  - --refresh-command string: Command to run before auto-refresh on save
+  - --local-upstream string: Host to act as origin in development
+  - --debug boolean: Output debug logs (default: false)
+
+---
 
-#### list
+### esa-cli commit [entry]
 
-List all your routines.
+Commit your code and save as a new version.
 
 ```bash
-$ esa routine list
+esa-cli commit [entry]
 ```
 
-### route [script]
+- Options:
+  - -m, --minify boolean: Minify code before committing (default: false)
+  - -a, --assets string: Assets directory
+  - -d, --description string: Description for Functions& Pages/version (skip interactive input)
+  - -n, --name string: Functions& Pages name
 
-Manage the routes bound to your routine.
-    
-#### add [route] [site]
+---
 
-Bind a Route to a routine.
+### esa-cli deploy [entry]
+
+Deploy your project.
 
 ```bash
-$ esa route add [route] [site]
+esa-cli deploy [entry]
 ```
 
-#### delete <route>
+- Positionals:
+  - entry: Entry file of Functions& Pages
 
-Delete a related route.
+- Options:
+  - -v, --version string: Version to deploy (skip interactive selection)
+  - -e, --environment string: Environment to deploy to. Choices: staging | production
+  - -n, --name string: Name of Functions& Pages
+  - -a, --assets string: Assets directory (e.g., ./dist)
+  - -d, --description string: Description of the version
+  - -m, --minify boolean: Minify the code
+
+---
+
+### esa-cli deployments list
+
+List all deployments.
 
 ```bash
-$ esa route delete <route>
+esa-cli deployments list
 ```
 
-- route `string` `required`
-- The name of the routes to delete.
+No additional options.
 
-#### list
+---
 
-List all related routes.
+### esa-cli deployments delete [deploymentId...]
+
+Delete one or more deployment versions.
 
 ```bash
-$ esa route list
+esa-cli deployments delete [deploymentId...]
 ```
 
-### login
+- Positionals:
+  - deploymentId...: Deployment version IDs to delete (one or more)
 
-Login to the server.
-    
-```bash
-$ esa login
-```
+---
 
-### dev [entry]
+### esa-cli project list
+
+List all your projects.
 
-Start a local server for developing your routine.
-    
 ```bash
-$ esa dev [entry] [OPTIONS]
+esa-cli project list
 ```
 
-- entry `string` `optional`
-- Entry file of the Routine.
+No additional options.
 
-- -port, --p `number` `optional`
-- Port to listen on.
+---
 
-- --inspect-port `number` `optional`
-- Chrome inspect devTool port.
+### esa-cli project delete <projectName>
 
-- -minify, --m `boolean` `optional`
-- Minify code during development.
+Delete a project.
 
-- --local-upstream `string` `optional`
-- Host to act as origin in development.
+```bash
+esa-cli project delete <projectName>
+```
 
-- --refresh-command `string` `optional`
-- Provide a command to be executed before the auto-refresh on save.
+- Positionals:
+  - projectName: The name of the project to delete
 
-### deployments [script]
+---
 
-Manage your deployments.
-    
-#### delete <deploymentId>
+### esa-cli site list
 
-Delete one or more deployment versions.
+List all your sites.
 
 ```bash
-$ esa deployments delete <deploymentId>
+esa-cli site list
 ```
 
-- deploymentId `string` `required`
-- The ID of the deployments to delete.
+No additional options.
 
-#### list
+---
 
-List all deployments.
+### esa-cli domain add <domain>
+
+Bind a domain to your project.
 
 ```bash
-$ esa deployments list
+esa-cli domain add <domain>
 ```
 
-### deploy [entry]
+- Positionals:
+  - domain: The domain name to bind
+
+---
+
+### esa-cli domain list
+
+List all related domains.
 
-Deploy your project.
-    
 ```bash
-$ esa deploy [entry]
+esa-cli domain list
 ```
 
-- entry `string` `optional`
-- Entry file of the Routine.
+No additional options.
 
-### domain [script]
+---
 
-Manage the domain names bound to your routine.
-    
-#### add <domain>
+### esa-cli domain delete <domain>
 
-Bind a domain to a routine.
+Delete a related domain.
 
 ```bash
-$ esa domain add <domain>
+esa-cli domain delete <domain>
 ```
 
-- domain `string` `required`
-- The name of domain to add.
+- Positionals:
+  - domain: The domain name to delete
 
-#### delete <domain>
+---
 
-Delete a related domain.
+### esa-cli route add
+
+Bind a route to the current project.
 
 ```bash
-$ esa domain delete <domain>
+esa-cli route add [route] [site] [--alias <routeName>] [--route <route>] [--site <site>]
 ```
 
-- domains `string` `required`
-- The names of the related domains to delete.
+- Positionals (optional):
+  - route: The route value, e.g. example.com/_ or _.example.com/\*
+  - site: The site name, e.g. example.com
 
-#### list
+- Options:
+  - -r, --route string: Route value, e.g. example.com/\*
+    - Host supports leading `*` for suffix match (e.g., `*.example.com`)
+    - Path supports trailing `*` for prefix match (e.g., `/api/*`)
+  - -s, --site string: Site name (must be an active site)
+  - -a, --alias string: Route name (alias)
 
-List all related domains.
+---
+
+### esa-cli route list
+
+List all related routes.
 
 ```bash
-$ esa domain list
+esa-cli route list
 ```
 
-### commit [entry]
+No additional options.
+
+---
+
+### esa-cli route delete <routeName>
+
+Delete a related route.
 
-Commit your code, save as a new version.
-    
 ```bash
-$ esa commit [entry] [OPTIONS]
+esa-cli route delete <routeName>
 ```
 
-- entry `string` `optional`
-- Entry file of the Routine.
+- Positionals:
+  - routeName: The name of the route to delete
 
-- -m, --minify `boolean` `optional`
-- Minify code before committing.
+---
 
-### logout
+### esa-cli login
+
+Login to the server.
 
-Logout.
-    
 ```bash
-$ esa logout
+esa-cli login
 ```
 
-### config
+- Options:
+  - --access-key-id, --ak string: AccessKey ID (AK)
+  - --access-key-secret, --sk string: AccessKey Secret (SK)
+
+---
+
+### esa-cli logout
+
+Logout.
 
-Modify your local or global configuration using -l, -g.
-    
 ```bash
-$ esa config [OPTIONS]
+esa-cli logout
 ```
 
-- -g, --global `boolean` `optional`
-- Edit global config file.
+---
 
-- -l, --local `boolean` `optional`
-- Edit local config file.
+### esa-cli config [-l | -g]
 
-### lang
+Modify your local or global configuration.
 
-Set the language of the CLI.
-    
 ```bash
-$ esa lang
+esa-cli config [--local] [--global]
 ```
 
-### site [script]
+- Options:
+  - -l, --local boolean: Edit local config file (default: false)
+  - -g, --global boolean: Edit global config file (default: false)
 
-Manage your sites.
-    
-#### list
+---
 
-List all your sites.
+### esa-cli lang
+
+Set the language of the CLI.
 
 ```bash
-$ esa site list
+esa-cli lang
 ```