esa-cli 0.0.2-beta.2 → 0.0.2-beta.20

package/dist/docs/Commands_en.md

@@ -1,224 +1,235 @@
-# Commands
+## Commands
 
-### init
+### esa init [name]
+
+Initialize a routine with a template or a framework.
 
-Initialize a routine with a template.
-    
 ```bash
-$ esa init [OPTIONS]
+esa 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 dev [entry]
 
-Delete a routine.
+Start a local server for developing your routine.
 
 ```bash
-$ esa routine delete <routineName>
+esa dev [entry]
 ```
 
-- routineName `string` `required`
-- The name of the routine to delete.
+- Positionals:
+  - entry: Entry file of the Routine
 
-#### list
+- 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 all your routines.
+---
+
+### esa commit [entry]
+
+Commit your code and save as a new version.
 
 ```bash
-$ esa routine list
+esa commit [entry]
 ```
 
-### route [script]
+- Options:
+  - -m, --minify boolean: Minify code before committing (default: false)
+  - -a, --assets string: Assets directory
+  - -d, --description string: Description for the routine/version (skip interactive input)
+  - -n, --name string: Edge Routine name
 
-Manage the routes bound to your routine.
-    
-#### add [route] [site]
+---
 
-Bind a Route to a routine.
+### esa deploy [entry]
+
+Deploy your project.
 
 ```bash
-$ esa route add [route] [site]
+esa deploy [entry]
 ```
 
-#### delete <route>
-
-Delete a related route.
+- Positionals:
+  - entry: Entry file of the Routine
 
-```bash
-$ esa route delete <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 the routine
+  - -a, --assets string: Assets directory (e.g., ./dist)
+  - -d, --description string: Description of the version
+  - -m, --minify boolean: Minify the code
 
-- route `string` `required`
-- The name of the routes to delete.
+---
 
-#### list
+### esa deployments [list | delete]
 
-List all related routes.
+Manage your deployments.
 
 ```bash
-$ esa route list
+esa deployments list
+esa deployments delete [deploymentId...]
 ```
 
-### login
+- Subcommands:
+  - list: List all deployments
+  - delete [deploymentId...]: Delete one or more deployment versions
 
-Login to the server.
-    
-```bash
-$ esa login
-```
+---
 
-### dev [entry]
+### esa routine [list | delete]
+
+Manage your routines.
 
-Start a local server for developing your routine.
-    
 ```bash
-$ esa dev [entry] [OPTIONS]
+esa routine list
+esa routine delete <routineName>
 ```
 
-- entry `string` `optional`
-- Entry file of the Routine.
+- Subcommands:
+  - list: List all your routines
+  - delete <routineName>: Delete a routine
 
-- -port, --p `number` `optional`
-- Port to listen on.
+---
 
-- --inspect-port `number` `optional`
-- Chrome inspect devTool port.
+### esa site [list]
 
-- -minify, --m `boolean` `optional`
-- Minify code during development.
+Manage your sites.
 
-- --local-upstream `string` `optional`
-- Host to act as origin in development.
+```bash
+esa site list
+```
 
-- --refresh-command `string` `optional`
-- Provide a command to be executed before the auto-refresh on save.
+- Subcommands:
+  - list: List all your sites
 
-### deployments [script]
+---
 
-Manage your deployments.
-    
-#### delete <deploymentId>
+### esa domain <add | list | delete>
 
-Delete one or more deployment versions.
+Manage the domain names bound to your routine.
 
 ```bash
-$ esa deployments delete <deploymentId>
+esa domain add <domain>
+esa domain list
+esa domain delete <domain>
 ```
 
-- deploymentId `string` `required`
-- The ID of the deployments to delete.
-
-#### list
+- Subcommands:
+  - add <domain>: Bind a domain to a routine
+  - list: List all related domains
+  - delete <domain>: Delete a related domain
 
-List all deployments.
+---
 
-```bash
-$ esa deployments list
-```
+### esa route <add | list | delete>
 
-### deploy [entry]
+Manage the routes bound to your routine.
 
-Deploy your project.
-    
 ```bash
-$ esa deploy [entry]
+esa route add
+esa route list
+esa route delete <routeName>
 ```
 
-- entry `string` `optional`
-- Entry file of the Routine.
+- Subcommands:
+  - add: Bind a Route to a routine
+  - list: List all related routes
+  - delete <routeName>: Delete a related route
 
-### domain [script]
+#### esa route add
 
-Manage the domain names bound to your routine.
-    
-#### add <domain>
-
-Bind a domain to a routine.
+Bind a route to the current routine.
 
 ```bash
-$ esa domain add <domain>
+esa route add [route] [site] [--alias <routeName>] [--route <route>] [--site <site>]
 ```
 
-- domain `string` `required`
-- The name of domain to add.
+- Positionals (optional):
+  - route: The route value, e.g. example.com/_ or _.example.com/\*
+  - site: The site name, e.g. example.com
 
-#### delete <domain>
+- 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)
 
-Delete a related domain.
+- Interactive behavior:
+  - If `--alias` is missing, you will be prompted to input a route name
+  - If `--site` is missing, you will be prompted to choose from active sites
+  - If `--route` is missing, you will be prompted to input the route value
 
-```bash
-$ esa domain delete <domain>
-```
+- Route matching notes:
+  - Host supports `*` prefix: `*.example.com` matches any host ending with `.example.com`
+  - Path supports `*` suffix: `/api/*` matches any path starting with `/api/`
+  - Examples: `example.com/*`, `*.example.com/`, `*.example.com/api/*`
 
-- domains `string` `required`
-- The names of the related domains to delete.
+- Examples:
+  - `esa route add -a home -s example.com -r example.com/*`
+  - `esa route add example.com/* example.com -a home`
 
-#### list
+---
 
-List all related domains.
+### esa login
 
-```bash
-$ esa domain list
-```
-
-### commit [entry]
+Login to the server.
 
-Commit your code, save as a new version.
-    
 ```bash
-$ esa commit [entry] [OPTIONS]
+esa login
 ```
 
-- entry `string` `optional`
-- Entry file of the Routine.
+- Options:
+  - --access-key-id, --ak string: AccessKey ID (AK)
+  - --access-key-secret, --sk string: AccessKey Secret (SK)
 
-- -m, --minify `boolean` `optional`
-- Minify code before committing.
+---
 
-### logout
+### esa logout
 
 Logout.
-    
-```bash
-$ esa logout
-```
 
-### config
-
-Modify your local or global configuration using -l, -g.
-    
 ```bash
-$ esa config [OPTIONS]
+esa logout
 ```
 
-- -g, --global `boolean` `optional`
-- Edit global config file.
+---
 
-- -l, --local `boolean` `optional`
-- Edit local config file.
+### esa config [-l | -g]
 
-### lang
+Modify your local or global configuration.
 
-Set the language of the CLI.
-    
 ```bash
-$ esa lang
+esa 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 lang
+
+Set the language of the CLI.
 
 ```bash
-$ esa site list
+esa lang
 ```