# mincloud > mincloud is an ifanr faas cli Latest version **1.3.4** (published 2024-08-28) · Apache-2.0 license · 0 weekly downloads ## Install ```sh npm install mincloud pnpm add mincloud yarn add mincloud bun add mincloud ``` Provides the command `mincloud`. ## 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 | 1.3.4 | | Published | 2024-08-28 | | First published | 2018-10-16 | | Weekly downloads | 0 | | License | Apache-2.0 | | TypeScript types | none | | Module format | CommonJS | | Node | >=6.14.0 | | Dependencies | 14 | | Unpacked size | 93.1 KB | | Known vulnerabilities | 0 (+1 in 1 direct dependencies) | | Install scripts | no | | GitHub stars | 3 | | Maintainers | secops, yanjiajun, xunuo_ifanr, haihongli | | Keywords | faas, cli | ## Links - npm: https://www.npmjs.com/package/mincloud - Repository: https://github.com/ifanrx/faas-cli - Homepage: https://github.com/ifanrx/faas-cli#readme - Issues: https://github.com/ifanrx/faas-cli/issues - npm.io page: https://npm.io/package/mincloud ## Dependencies (14) - [nopt](https://npm.io/package/nopt.md) ^4.0.1 - [osenv](https://npm.io/package/osenv.md) ^0.1.5 - [mkdirp](https://npm.io/package/mkdirp.md) ^0.5.1 - [npmlog](https://npm.io/package/npmlog.md) ^4.1.2 - [rimraf](https://npm.io/package/rimraf.md) ^2.6.2 - [request](https://npm.io/package/request.md) ^2.88.2 - [archiver](https://npm.io/package/archiver.md) ^5.3.1 - [columnify](https://npm.io/package/columnify.md) ^1.5.4 - [prettyjson](https://npm.io/package/prettyjson.md) ^1.2.1 - [config-chain](https://npm.io/package/config-chain.md) ^1.1.12 - [babel-polyfill](https://npm.io/package/babel-polyfill.md) ^6.26.0 - [util.promisify](https://npm.io/package/util.promisify.md) ^1.0.0 - [babel-preset-stage-2](https://npm.io/package/babel-preset-stage-2.md) ^6.24.1 - [lodash.isplainobject](https://npm.io/package/lodash.isplainobject.md) ^4.0.6 ## Alternatives - [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads - [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads - [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads - [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads - [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads ## Recent versions - 1.3.4 (latest) — 2024-08-28 - 1.3.3 — 2024-08-26 - 1.3.2 — 2024-07-08 - 1.3.1 — 2024-03-14 - 1.3.0 — 2024-03-13 - 1.2.6 — 2024-03-13 - 1.2.5 — 2024-03-13 - 1.2.4 — 2024-03-13 - 1.2.3 — 2023-09-05 - 1.2.2 — 2022-11-16 - 1.2.1 — 2022-11-11 - 1.2.0 — 2022-11-08 - 1.1.0 — 2022-10-09 - 1.0.7 — 2022-09-26 - 1.0.6 — 2020-01-09 - … 5 more at https://npm.io/package/mincloud/versions ## README # mincloud [![Build Status](https://travis-ci.org/ifanrx/faas-cli.svg?branch=master)](https://travis-ci.org/ifanrx/faas-cli) 这是一个用于知晓云[云函数](https://doc.minapp.com/cloud-function/)的命令行工具。 ## 快速开始 1. 安装运行时 [node.js](https://nodejs.org/) 2. 安装本命令行工具 通过 npm 安装： ``` $ npm install -g mincloud ``` 通过 yarn 安装： ``` $ yarn global add mincloud ``` 3. 调用 ``` $ mincloud 用法： mincloud 支持的 command 有： delete, deploy, invoke, list, login, logout, new - mincloud: v1.1.0 - node: v8.10.0 ``` ## 命令的使用 flag | 说明 ------------|------------------------------------- -j, --json | 调用命令成功后，以 json 格式返回结果 -e, --env | 可选，表示在指定的环境中执行命令 在知晓云[设置页面](https://cloud.minapp.com/dashboard/#/app/settings/app/)，选择环境，并查看环境 ID。 ### 删除云函数 必须先登录，请参考 `mincloud login`。谨慎操作，此操作会将服务器上的云函数删除。 ``` $ mincloud delete ``` 参数 | 必填 | 默认值 | 说明 --------------|-------|--------|----------------- function_name | 是 | 无 | 已经存在的云函数 ### 部署云函数 必须先登录，请参考 `mincloud login`。 ``` $ mincloud deploy [cloud_function_root] [-m remark] ``` 参数 | 必填 | 默认值 | 说明 --------------------|-------|---------------|-------------------------------------------------------------------------- function_name | 是 | 无 | 云函数名，指定的是 `.js` 或者 `/index.js` cloud_function_root | 否 | 当前目录 `./` | 用于存放云函数代码的本地目录 flag | 说明 --------------|------------------------------------ -m, --message | 备注信息 ### 调用云函数 必须先登录，请参考 `mincloud login`。 ``` $ mincloud invoke [data] ``` 参数 | 必填 | 默认值 | 说明 --------------|-------|-------------|----------------- function_name | 是 | 无 | 已经存在的云函数 data | 否 | 空对象 `{}` | JSON 数据 ### 列出云函数 必须先登录，请参考 `mincloud login`。 ``` $ mincloud list ``` ### 登录 使用知晓云[客户端凭证](https://cloud.minapp.com/dashboard/#/app/settings/app/)登录，令牌将保存在本地文件 `.mincloudrc` 中；若过期，请重新登录。 查找令牌的步骤： 1. 在当前工作目录的 `.mincloudrc` 中查找 `client_id`；若找不到，则在用户根目录的 `.mincloudrc` 中查找。 2. 通过找到的 `client_id` 到用户根目录的 `.mincloudrc` 中查找客户端登录凭证。 ``` $ mincloud login ``` 参数 | 必填 | 默认值 | 说明 --------------|-------|--------|----------------------- client_id | 是 | 无 | 知晓云的客户端 ID client_secret | 是 | 无 | 知晓云的客户端密钥 flag | 说明 --------------|------------------------------------ -l, --local | 在当前工作目录保存 client_id ### 注销 ``` $ mincloud logout ``` ### 本地创建一个云函数文件 必须先登录，请参考 `mincloud login`。 此命令将在服务器上创建一个简单的云函数，本地创建云函数代码， 文件夹即函数名，入口文件即 `/index.js`。 ``` $ mincloud new [cloud_function_root] [-m remark] ``` 参数 | 必填 | 默认值 | 说明 --------------------|-------|---------------|-------------------------------------------------------------------------- function_name | 是 | 无 | 云函数名 cloud_function_root | 否 | 当前目录 `./` | 用于存放云函数代码的本地目录 flag | 说明 --------------|------------------------------------ -m, --message | 备注信息 ### 从服务器上拉取一个已存在的云函数代码到本地 必须先登录，请参考 `mincloud login`。 请谨慎操作，如果本地有此代码文件，将会覆盖。 ``` $ mincloud pull [cloud_function_root] ``` 参数 | 必填 | 默认值 | 说明 --------------------|-------|---------------|-------------------------------------------------------------------------- function_name | 是 | 无 | 云函数名 cloud_function_root | 否 | 当前目录 `./` | 用于存放云函数代码的本地目录 ### 运营后台部署 必须先登录，请参考 `mincloud login`。 CLI 版本需大于等于 1.2.2。 该命令可将本地前端项目部署到运营后台。 ``` $ mincloud dashboard-deploy ``` 参数 | 必填 | 默认值 | 说明 --------------------|-------|---------------|-------------------------------------------------------------------------- file_path | 是 | 无 | 文件路径，可以是一个目录，或者是一个 zip 文件。如果是 zip 文件，则注意压缩时需把项目根路径压缩，而不是把项目目录文件夹压缩。 flag | 说明 --------------|------------------------------------ -r, --refresh | 是否刷新管理后台部署地址，取值为：true or false。可为空，默认为 true。 --- _Source: https://npm.io/package/mincloud · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._