You need to enable JavaScript to run this app.
Volcano Engine Function as a Service

Volcano Engine Function as a Service

Copy page
Download PDF
CLI reference
Installing the CLI
Copy page
Download PDF
Installing the CLI
This topic describes how to install the veFaaS CLI and how to manage CLI versions and login.​
Install the CLI​
Install the CLI using the following code.​
​
npx @volcengine/vefaas-cli@latest install​
​
Manage versions​
Disable the version update prompt​
By default, the CLI checks for newer versions and prompts for updates when you run the version command. To disable this prompt, set the environment variable NO_UPDATE_NOTIFIER to 1.​
​
export NO_UPDATE_NOTIFIER=1​
vefaas --version​
​
Disable telemetry data reporting​
By default, the CLI reports anonymous basic telemetry data when running commands. To disable this reporting behavior, set the environment variable VEFAAS_TELEMETRY_DISABLED to true or set DO_NOT_TRACK to true.​
​
export VEFAAS_TELEMETRY_DISABLED=true​
export DO_NOT_TRACK=true​
​
View the current version​
​
vefaas --version​
​
Upgrade to the latest version​
​
vefaas --version​
vefaas update​
​
Manage login​
Account login​
  1. In your terminal, use vefaas login to log in.​
  1. Follow the prompts to log in using either a Volcano Engine account or AK/SK. Then, press Enter to confirm.​
  • AK/SK: The key pair consists of an Access Key ID (AK) and an Access Key Secret (SK). For details, see Access Key management.​
  • Volcano Engine account: Open the SSO login page in your browser, select the Volcano Engine account you wish to use and authorize it. Upon successful login, you will see a message indicating that the authentication is complete. You may then close the browser tab to finish the login process.​
Non-interactive login​
This is suitable for scenarios such as Coding Agents, where frequent interaction with the terminal is not feasible.​
​
vefaas login --accessKey AKID --secretKey SKID​
​
Log in via environment variables​
Set login information in environment variables for efficient key management and to prevent key leakage.​
​
export VOLC_ACCESS_KEY_ID="YOUR_AK"​
export VOLC_SECRET_ACCESS_KEY="YOUR_SK"​
# Optional if the STS token is used.​
# export VOLC_SESSION_TOKEN="YOUR_STS_TOKEN"​
​
Verify login status​
​
vefaas login --check​
​
Log out​
​
vefaas logout​
​
​
Last updated: 2026.08.19 14:06:08