Command Operation Documentation
Preface
Serverless Devs can invoke the corresponding help documentation for commands using -h. For example, to view help information for the s command, you can use: s -h
$ s -h
π Welcome to the Serverless Devs
Usage: s [options] [command]
Options:
--debug Open debug model
--skip-actions Skip the extends section
-t, --template <path> Specify the template file
-a, --access <aliasName> Specify the access alias name
-o, --output <outputFormat> Specify the output format (choices: "default", "json", "yaml", "raw")
--output-file <outputFilePath> Specify the output file path
--env <envName> Specify the env name
--no-verify Do not verify yaml
--silent Silent mode
-v, --version Output the version number
-h, --help Display help for command
Commands:
config π€ Configure vendors account
env π± Environment operation
set π§ Settings for the tool
registry π’ Serverless registry platform
preview π Preview Yaml render results
component π Installed component information
clean [options] π₯ Clean up the environment
init [options] π Initializing a serverless project
verify π Verify Yaml content
<custom> π§ Custom Commands
π Quick Start: https://manual.serverless-devs.com/getting-started/
π Github Repo: https://github.com/Serverless-Devs/Serverless-Devs
π‘ Documentation: https://manual.serverless-devs.com
π Example Projects: https://registry.serverless-devs.com
π Feedback: https://github.com/Serverless-Devs/Serverless-Devs/issues
Global Parameters
| Full Parameter | Abbreviation | Default Value | Meaning | Notes |
|---|---|---|---|---|
| template | t | s.yaml/s.yml | Specify the resource description file | |
| access | a | Specified in yaml or default | Specify the key information for the deployment | Can use keys configured via config command, as well as keys configured in environment variables |
| skip-actions | - | - | Skip the actions module set in yaml | - |
| debug | - | - | Enable Debug mode | Enabling Debug mode allows viewing more information about tool execution |
| output | o | default | Specify the data output format | Supports default, json, yaml, raw formats |
| version | v | - | View version information | - |
| help | h | - | View help information | - |
| silent | - | - | Silent mode | Will only output component execution results |
| env | - | - | Specify the environment | Used in multi-environment scenarios |
| output-file | - | - | Specify the output file path | - |
| no-verify | - | - | Do not verify yaml file | - |