open-index/open-npm huggingface dataset:
npm package: @serverless/sdk-schema
Description: This is the auto generated NPM package from the Serverless Protobufs. Serverless uses Protobufs as the required format for all instrumentation libraries that communicate with the Serverless Platform.
Author: Serverless, Inc.
Latest version: 0.15.6

# Serverless SDK Schema

This is the auto generated NPM package from the Serverless Protobufs. Serverless uses Protobufs as the required format for all instrumentation libraries that communicate with the Serverless Platform.
npm package: @serverless/serverless-tencent-plugin
Description: Serverless Tencent plugin
Author: Serverless, Inc.
Latest version: 0.0.7

# serverless-tencent-plugin

此插件提供了在 [serverless](https://www.serverless.com/) 中使用腾讯云功能的支持

## 快速开始

### 前置条件

1. Nodejs 10.x 及以上版本
2. Serverless CLI `v2.0+`, 如果没有安装可以使用 `npm i -g serverless` 命令安装
3. 腾讯云账号以及对应权限开通:https://cloud.tencent.com/document/product/1154/43006

### 新建 serverless 应用

`sereverless init scf-nodejs --name example`

### 部署应用

`cd example && serverless deploy`

如果没有配置全局认证信息，需要用户进行扫码登陆验证

### 删除应用

`serverless remove`

## CLI 命令列表

### `serverless registry`

查看可用的 组件（Components）以及模板（Template） 列表

### `serverless publish`

发布组件（Components）或者模板（Template） 到 Serverless 注册中心

`--dev` - 支持 dev 参数用于发布 `@dev` 版本的 Component，用于开发或测试，此参数仅对组件有效，对模板无效，模板没有版本的概念。

### `serverless init`

选择一个模板初始化项目

### `serverless deploy`

部署一个 Component 实例到云端

`--debug` - 列出组件部署过程中 `console.log()` 输出的部署操作和状态等日志信息。

### `serverless remove`

从云端移除一个 Component 实例

`--debug` - 列出组件移除过程中 `console.log()` 输出的移除操作和状态等日志信息。

### `serverless info`

获取并展示一个 Component 实例的相关信息

`--debug` - 列出更多 `state`.

### `serverless dev`

启动 DEV MODE 开发者模式，通过检测 Component 的状态变化，自动部署变更信息。同时支持在命令行中实时输出运行日志，调用信息和错误等。此外，支持对 Node.js 应用进行云端调试。

### `serverless logs`

获取实例的运行日志

### `serverless invoke`

命令行对已部署实例进行调用

### `serverless invoke local`

命令行对代码进行本地调用

### `serverless version`

查看当前使用的插件版本

### `serverless credentials`

设置 腾讯云全局认证信息

#### `serverless credentials set`

认证信息设置

#### `serverless credentials remove`

认证信息删除

#### `serverless credentilas list`

列出当前已设置的认证信息

### `serverless help`, `serverless xxxx --help`

输出全局帮助信息，以及具体某一命令的具体参数和帮助信息

### `serverless <command> --inputs key=value foo=bar`

在运行命令时覆盖 `serverless.yml` 中的 inputs

例子:

```
# 简单的例子
serverless test --inputs domain=serverless.com
# 传递对象: 使用 JSON 格式
serverless invoke --inputs env='{"LANG": "en"}'
# 传递 Array: 用逗号分隔
serverless backup --inputs userIds=foo,bar
```

## 代码发布

### Canary 测试版本

提交代码到 `master` 分支，自动发布插件的 `canary` 版本，可以通过 `npm i @serverless/serverless-tencent-plugin@canary` 安装测试

### 发布正式版本

1. 功能完成之后，需要修改 `package.json/version` 字段以及在 `CHANGELOG.md` 中写明更新日志
2. 提交代码到 `master`, 合并之后自动发布正式版本
npm package: @serverless/sf
Description: N/A
Author: Serverless, Inc.
Latest version: 0.0.6

# Serverless Framework V.2

&nbsp;

> _"The future of cloud is outcomes, not infrastructure."_

&nbsp;

* [Chat App](./examples/chat-app)
* [Realtime App](./examples/realtime-app)
* [Websockets Backend](./examples/socket)
* [Website](./examples/website)
* [AWS Lambda Function](./examples/aws-lambda)

&nbsp;

## Get Started

Clone repo.

```bash
$ git clone https://github.com/serverless/v2.git
```

Install dependencies.

```
cd v2 && npm i -g
```

Pick an [example](./examples). Each example requires credentials for Amazon Web Services set as environment variables.

Serverless Framework V.2 supports `.env` files in the same folder as `serverless.yml` or `serverless.js`.  Create one that looks like this:

```text
AWS_ACCESS_KEY_ID=123456789
AWS_SECRET_ACCESS_KEY=987654321
```

Run `$ v2`.

```bash
$ website: v2
  
  ✔  my-site

     URL  http://serverless-6vql3jp9.s3-website-us-east-1.amazonaws.com

  3s › dev › my-site › Done
```

You can leverage different environment variables for different stages by using this naming convention:

```
.env # Default
.env.dev
.env.prod
```

### How To Use A Serverless Component Programmatically

Create a new javascript file, and load/use Components like this:

```javascript

// To load a Component, instantiate it's class...
const realtimeApp = new RealtimeApp('instanceId', { /* inputs */ })

// To run/deploy/update a Component, call it's default function...
await realtimeApp()

// To run extra functionality, use custom methods that come w/ the Component...
await realtimeApp.loadTest()
```

### How To Use A Serverless Component Declaratively

Use a `serverless.yml` file, like this:

```yaml

name: realtimeApp
stage: dev

providers:
  AwsProvider::aws:
    accessKeyId: ${secrets:aws_access_key_id}
    secretAccessKey: ${secrets:secret_access_key}

components:
  RealtimeApp::realtimeApp:
    name: ${name}-${stage}
    code: ./src/backend
```

Then use your CLI, like this:

```bash
# To run/deploy/update all Components, call 'serverless'...
$ serverless

# To run extra functionality that comes with the a component, call this...
$ serverless loadTest myRealtimeApp

# To remove Components in YAML, call this...
$ serverless remove
```

### How To Write A Serverless Component

Use a `serverless.js` file, like this:

```javascript

class MyComponent extends Component {

  /*
  * Default (Required)
  * - The default functionality to run/provision/update your Component
  */

  async default() { }

  /*
  * Remove (Optional)
  * - If your Component removes infrastructure, this is recommended.
  */

  async remove() { }
}

```

**Created By**

* Eslam Hefnawy - @eahefnawy
* Philipp Muens - @pmmuens