volcengine-vefaas

volcengine-vefaas：Volcengine FaaS CLI

vefaas は、Volcengine Function Service（veFaaS）のコマンドラインツールです。合理化されたワークフローを通じて、サーバーレスアプリケーションのデプロイ、関数の管理、設定を行えます。

インストール

npm i -g https://vefaas-cli.tos-cn-beijing.volces.com/volcengine-vefaas-latest.tgz

インストールを確認します。

vefaas --version

基本的なワークフロー

一般的なデプロイ手順は次のとおりです。

1. Node.js の確認：node --version（>= 18 が必要です。20 以降を推奨します）
   • バージョンが古い場合は、nvm（nvm use 20）または fnm（fnm use 20）で切り替えるか、新しいバージョンを手動でインストールします
2. CLI の確認：vefaas --version でインストールを確認します
3. 認証の確認：vefaas login --check でログイン状態を確認します
   • 未ログインの場合は、vefaas login --sso を実行します（ブラウザーが開き、ユーザーの認証後に自動で完了します。手動入力は不要です）
4. デプロイ：vefaas deploy --newApp <name> --gatewayName $(vefaas run listgateways --first) --yes
5. アクセス：vefaas domains で URL を確認します

クイックコマンド

目的	コマンド
認証を確認	vefaas login --check
ログイン（SSO）	vefaas login --sso（非対話型：ブラウザーが開き、認証後に自動で完了します。推奨）
ログイン（AK/SK）	vefaas login --accessKey <AK> --secretKey <SK>
テンプレートから初期化	vefaas init --template <name>
新しいアプリをデプロイ	vefaas deploy --newApp <name> --gatewayName $(vefaas run listgateways --first) --yes
既存のアプリをデプロイ	vefaas deploy --app <name> --yes
ゲートウェイを一覧表示	vefaas run listgateways --first
URL を表示	vefaas domains
環境変数を設定	vefaas env set KEY VALUE
設定を表示	vefaas config list
コードを取得	vefaas pull --func <name>
プロジェクトを調査	vefaas inspect

グローバルオプション

オプション	説明
-d, --debug	トラブルシューティング用のデバッグモードを有効にします
--yes	非対話型モード（CI／AI コーディングでは必須です）
--region	リージョンを上書きします（例：cn-beijing）

クックブック

よくあるシナリオの手順ガイドです。

• テンプレートのクイックスタート - 公式テンプレートから作成してデプロイします
• 既存コードのデプロイ - 既存のプロジェクトをデプロイします
• 関数の管理 - 関数を管理します（コードの取得、アップロード、デプロイ）

リファレンス

各トピックの詳細なドキュメントです。

• 認証 - ログイン方法と認証情報
• 設定 - 設定ファイルと設定項目
• 環境変数 - 環境変数の管理
• フレームワークの検出 - 対応フレームワークと自動検出
• MCP のデプロイ - MCP プロトコル、run.sh、プロキシ、パス選択の確認
• トラブルシューティング - デバッグモード、よくある問題と解決策

重要な注意事項

• CI/CD と AI コーディングのシナリオでは、非対話型モードにするため、必ず --yes を使用してください
• 利用可能なゲートウェイを取得するには、$(vefaas run listgateways --first) を使用してください
• リンク後、設定は .vefaas/config.json に保存されます
• 問題のトラブルシューティングには、--debug または -d を使用してください