# @serverless/tencent-scf > Tencent Serverless Cloud Function Latest version **3.0.9** (published 2020-04-23) · Apache license · 0 weekly downloads ## Install ```sh npm install @serverless/tencent-scf pnpm add @serverless/tencent-scf yarn add @serverless/tencent-scf bun add @serverless/tencent-scf ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 3.0.9 | | Published | 2020-04-23 | | First published | 2019-10-23 | | Weekly downloads | 0 | | License | Apache | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 15 | | Unpacked size | 6.8 MB | | Known vulnerabilities | 0 | | Install scripts | no | | Author | Tencent Cloud | | Maintainers | ac360, aj.stuyvenberg, anycodes, eahefnawy, hkbarton, serverless-main, yugasun | ## Links - npm: https://www.npmjs.com/package/@serverless/tencent-scf - npm.io page: https://npm.io/package/@serverless/tencent-scf ## Dependencies (15) - [ramda](https://npm.io/package/ramda.md) ^0.26.1 - [globby](https://npm.io/package/globby.md) ^9.2.0 - [ignore](https://npm.io/package/ignore.md) ^5.1.4 - [lodash](https://npm.io/package/lodash.md) ^4.17.15 - [archiver](https://npm.io/package/archiver.md) ^3.1.1 - [fs-extra](https://npm.io/package/fs-extra.md) ^8.1.0 - [cli-progress](https://npm.io/package/cli-progress.md) ^3.6.0 - [qrcode-terminal](https://npm.io/package/qrcode-terminal.md) ^0.12.0 - [@serverless/core](https://npm.io/package/@serverless/core.md) ^1.1.1 - [cos-nodejs-sdk-v5](https://npm.io/package/cos-nodejs-sdk-v5.md) ^2.5.12 - [tencentcloud-sdk-nodejs](https://npm.io/package/tencentcloud-sdk-nodejs.md) ^3.0.89 - [serverless-tencent-tools](https://npm.io/package/serverless-tencent-tools.md) ^1.0.1 - [@serverless/tencent-layer](https://npm.io/package/@serverless/tencent-layer.md) ^0.1.2 - [serverless-tencent-auth-tool](https://npm.io/package/serverless-tencent-auth-tool.md) ^2.0.1 - [@serverless/tencent-apigateway](https://npm.io/package/@serverless/tencent-apigateway.md) ^2.1.2 ## Recent versions - 3.0.9 (latest) — 2020-04-23 - 3.0.8 — 2020-04-23 - 3.0.7 — 2020-04-22 - 3.0.6 — 2020-04-22 - 3.0.5 — 2020-04-21 - 3.0.4 — 2020-03-20 - 3.0.3 — 2020-03-20 - 3.0.2 — 2020-03-16 - 3.0.1 — 2020-03-12 - 3.0.0 — 2020-03-10 - 2.1.4 — 2020-03-09 - 2.1.3 — 2020-03-04 - 2.1.2 — 2020-03-01 - 2.1.1 — 2020-02-27 - 2.1.0 — 2020-02-27 - … 26 more at https://npm.io/package/@serverless/tencent-scf/versions ## README # 腾讯云云函数SCF组件   * [请点击这里查看英文版部署文档](./README_EN.md) ## 简介 该组件是serverless-tencent组件库中的基础组件之一。通过云函数SCF组件，可以快速，方便的创建，配置和管理腾讯云的SCF云函数。 ## 快速开始   通过SCF组件，对一个云函数进行完整的创建，配置，部署和删除等操作。支持命令如下： 1. [安装](#1-安装) 2. [创建](#2-创建) 3. [配置](#3-配置) 4. [部署](#4-部署) 5. [移除](#5-移除)   ### 1. 安装 通过npm安装serverless ```console $ npm install -g serverless ``` ### 2. 创建 ``` $ mkdir my-function $ cd my-function ``` 目录内容如下： ``` |- code |- index.js |- serverless.yml ``` 对于该例子可以使用一下 Demo，作为 index.js： ```javascript 'use strict'; exports.main_handler = async (event, context, callback) => { console.log("%j", event); return "hello world" }; ``` ### 3. 配置 本地创建 `serverless.yml` 文件，在其中进行如下配置 ```console $ touch serverless.yml ``` ```yml # serverless.yml myFunction1: component: "@serverless/tencent-scf" inputs: name: myFunction1 codeUri: ./code # 代码目录 handler: index.main_handler runtime: Nodejs8.9 region: ap-guangzhou description: My Serverless Function memorySize: 128 timeout: 20 # 打包zip时希望忽略的文件或者目录配置（可选） exclude: - .gitignore - .git/** - node_modules/** - .serverless - .env include: - /Users/dfounderliu/Desktop/temp/.serverless/myFunction1.zip environment: variables: TEST: vale vpcConfig: subnetId: '' vpcId: '' myFunction2: component: "@serverless/tencent-scf" inputs: name: myFunction2 codeUri: ./code ``` * [点击此处查看配置文档](https://github.com/serverless-tencent/tencent-scf/blob/master/docs/configure.md) ### 4. 部署 如您的账号未[登陆](https://cloud.tencent.com/login)或[注册](https://cloud.tencent.com/register)腾讯云，您可以直接通过`微信`扫描命令行中的二维码进行授权登陆和注册。 通过`sls`命令进行部署，并可以添加`--debug`参数查看部署过程中的信息 ```console $ sls --debug DEBUG ─ Resolving the template's static variables. DEBUG ─ Collecting components from the template. DEBUG ─ Downloading any NPM components found in the template. DEBUG ─ Analyzing the template's components dependencies. DEBUG ─ Creating the template's components graph. DEBUG ─ Syncing template state. DEBUG ─ Starting Website Removal. DEBUG ─ Removing Website bucket. DEBUG ─ Removing files from the "my-bucket-1300415943" bucket. DEBUG ─ Removing "my-bucket-1300415943" bucket from the "ap-guangzhou" region. DEBUG ─ "my-bucket-1300415943" bucket was successfully removed from the "ap-guangzhou" region. DEBUG ─ Finished Website Removal. DEBUG ─ Executing the template's components graph. DEBUG ─ Compressing function myFunction file to /Users/dfounderliu/Desktop/temp/code/.serverless/myFunction.zip. DEBUG ─ Compressed function myFunction file successful DEBUG ─ Uploading service package to cos[sls-cloudfunction-ap-guangzhou-code]. sls-cloudfunction-default-myFunction-1572519895.zip DEBUG ─ Uploaded package successful /Users/dfounderliu/Desktop/temp/code/.serverless/myFunction.zip DEBUG ─ Creating function myFunction DEBUG ─ Created function myFunction successful myFunction: Name: myFunction Runtime: Nodejs8.9 Handler: index.main_handler MemorySize: 128 Timeout: 3 Region: ap-guangzhou Role: QCS_SCFExcuteRole Description: This is a template function UsingCos: true 6s › myFunction › done ``` ### 5. 移除 ```console $ sls remove --debug DEBUG ─ Flushing template state and removing all components. DEBUG ─ Removed function myFunction successful 1s › myFunction › done ``` #### 账号配置（可选） 当前默认支持CLI扫描二维码登录，如您希望配置持久的环境变量/秘钥信息，也可以本地创建 `.env` 文件 ```console $ touch .env # 腾讯云的配置信息 ``` 在 `.env` 文件中配置腾讯云的 SecretId 和 SecretKey 信息并保存。 ``` # .env TENCENT_SECRET_ID=123 TENCENT_SECRET_KEY=123 ``` >? > - 如果没有腾讯云账号，请先 [注册新账号](https://cloud.tencent.com/register)。 > - 如果已有腾讯云账号，可以在 [API密钥管理 ](https://console.cloud.tencent.com/cam/capi) 中获取 SecretId 和 SecretKey。 ### 还支持哪些组件？ 可以在 [Serverless Components](https://github.com/serverless/components) repo 中查询更多组件的信息。 --- _Source: https://npm.io/package/@serverless/tencent-scf · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._