npm package: @open-dy/cloud-cli
Description: 抖音云 CLI 工具
Author: douyincloud@bytedance.com
Latest version: 1.6.3

@open-dy/cloud-cli
=================

抖音云 CLI 工具

<!-- toc -->
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->
# Usage
<!-- usage -->
```sh-session
$ npm install -g @open-dy/cloud-cli
$ dycloud COMMAND
running command...
$ dycloud (--version)
@open-dy/cloud-cli/1.6.3 darwin-arm64 node-v18.20.8
$ dycloud --help [COMMAND]
USAGE
  $ dycloud COMMAND
...
```
<!-- usagestop -->
# Commands
<!-- commands -->
* [`dycloud container:build`](#dycloud-containerbuild)
* [`dycloud container:deploy`](#dycloud-containerdeploy)
* [`dycloud container:info`](#dycloud-containerinfo)
* [`dycloud container:list`](#dycloud-containerlist)
* [`dycloud container:pull`](#dycloud-containerpull)
* [`dycloud container:push`](#dycloud-containerpush)
* [`dycloud docker-file`](#dycloud-docker-file)
* [`dycloud dockerfile`](#dycloud-dockerfile)
* [`dycloud env:list`](#dycloud-envlist)
* [`dycloud env:switch`](#dycloud-envswitch)
* [`dycloud function:create`](#dycloud-functioncreate)
* [`dycloud function:debug`](#dycloud-functiondebug)
* [`dycloud function:deploy`](#dycloud-functiondeploy)
* [`dycloud function:list`](#dycloud-functionlist)
* [`dycloud function:pull`](#dycloud-functionpull)
* [`dycloud help [COMMAND]`](#dycloud-help-command)
* [`dycloud login`](#dycloud-login)
* [`dycloud logout`](#dycloud-logout)
* [`dycloud service:build`](#dycloud-servicebuild)
* [`dycloud service:deploy`](#dycloud-servicedeploy)
* [`dycloud service:info`](#dycloud-serviceinfo)
* [`dycloud service:list`](#dycloud-servicelist)

## `dycloud container:build`

根据云端模板在本地创建镜像，支持docker build指令参数透传，详见：https://docs.docker.com/engine/reference/commandline/build/

```
USAGE
  $ dycloud container:build [--service-name <value>]

FLAGS
  --service-name=<value>  服务名称
```

## `dycloud container:deploy`

部署当前环境下的指定服务

```
USAGE
  $ dycloud container:deploy [--service-name <value>] [-n <value>] [-t <value>] [--no-confirm] [--env-params <value>]
    [--service-size 1|2|3]

FLAGS
  -n, --note=<value>      发布备注
  -t, --tag=<value>       镜像版本号
  --env-params=<value>    环境变量，格式为 aa=bb&cc=dd，注意使用时添加引号 '"'
  --no-confirm            跳过二次确认
  --service-name=<value>  服务名称
  --service-size=(1|2|3)  容器规格，枚举值: 1 = 1核 1G; 2 = 2核 2G; 3 = 3核 3G

EXAMPLES
  $ dycloud container:deploy
```

## `dycloud container:info`

部署当前环境下的指定服务

```
USAGE
  $ dycloud container:info [--service-name <value>]

FLAGS
  --service-name=<value>  服务名称

EXAMPLES
  $ dycloud container:info
```

## `dycloud container:list`

当前环境下的服务列表

```
USAGE
  $ dycloud container:list

EXAMPLES
  $ dycloud container:list
```

## `dycloud container:pull`

拉取镜像至本地

```
USAGE
  $ dycloud container:pull [--service-name <value>]

FLAGS
  --service-name=<value>  服务名称

EXAMPLES
  $ dycloud container:pull
```

## `dycloud container:push`

推送镜像

```
USAGE
  $ dycloud container:push [--tag <value>] [--remark <value>] [--image-id <value>] [--service-name <value>] [-l]

FLAGS
  -l, --verbose           打印日志
  --image-id=<value>      本地镜像ID
  --remark=<value>        镜像备注
  --service-name=<value>  服务名称
  --tag=<value>           设置镜像的 TAG

EXAMPLES
  $ dycloud container:push
```

## `dycloud docker-file`

本地生成dockerfile

```
USAGE
  $ dycloud docker-file

ALIASES
  $ dycloud dockerfile
```

## `dycloud dockerfile`

本地生成dockerfile

```
USAGE
  $ dycloud dockerfile

ALIASES
  $ dycloud dockerfile
```

## `dycloud env:list`

查看环境列表

```
USAGE
  $ dycloud env:list

EXAMPLES
  $ dycloud env:list
```

## `dycloud env:switch`

切换当前 App 与环境

```
USAGE
  $ dycloud env:switch [--app-name <value>] [--app-id <value>] [--env dev|prod] [-l]

FLAGS
  -l, --verbose       打印日志
  --app-id=<value>    目标应用appId
  --app-name=<value>  目标应用
  --env=(dev|prod)    目标环境

EXAMPLES
  $ dycloud env:switch
```

## `dycloud function:create`

将本地函数服务代码进行 npm依赖安装和编译后部署到 dev 开发环境，支持覆盖云端编辑区草稿。如需修改发布配置、发布到 prod 环境请前往抖音云控制台操作。

```
USAGE
  $ dycloud function:create [--dir <value>] [--service-name <value>] [-n <value>] [--appId <value>] [--registry
    <value>] [-i] [--ideVersion <value>] [--session <value>] [--envId <value>] [--source <value>] [--type <value>]
    [--env <value>] [--channel <value>] [--rewrite-url <value>]

FLAGS
  -i, --isIDE             是否是ide
  -n, --note=<value>      发布备注
  --appId=<value>         appid
  --channel=<value>       channel
  --dir=<value>           发布的代码目录：默认为当前执行命令的文件夹，可指定
  --env=<value>           env
  --envId=<value>         envId
  --ideVersion=<value>    ide版本
  --registry=<value>      npm 镜像源
  --rewrite-url=<value>   channel
  --service-name=<value>  服务名称
  --session=<value>       session
  --source=<value>        source
  --type=<value>          type
```

## `dycloud function:debug`

1. 命令说明：同步所有的函数服务已发布的线上版本代码。如需下载某函数服务在云端编辑区的草稿代码，请前往控制台目录树区的「...」，点击「另存为草稿版本」后再下载到本地进行手动导入。

```
USAGE
  $ dycloud function:debug [--dir <value>] [--appId <value>] [--envId <value>] [-i] [--ideVersion <value>]
    [--session <value>] [--env <value>] [--channel <value>] [--rewrite-url <value>]

FLAGS
  -i, --isIDE            是否是ide
  --appId=<value>        appid
  --channel=<value>      channel
  --dir=<value>          调试的代码目录：默认为当前执行命令的文件夹，可指定
  --env=<value>          env
  --envId=<value>        envId
  --ideVersion=<value>   ide版本
  --rewrite-url=<value>  channel
  --session=<value>      sessionId

DESCRIPTION
  1. 命令说明：同步所有的函数服务已发布的线上版本代码。如需下载某函数服务在云端编辑区的草稿代码，请前往控制台目录树区的
  「...」，点击「另存为草稿版本」后再下载到本地进行手动导入。
```

## `dycloud function:deploy`

将本地函数服务代码进行 npm依赖安装和编译后部署到 dev 开发环境，支持覆盖云端编辑区草稿。如需修改发布配置、发布到 prod 环境请前往抖音云控制台操作。

```
USAGE
  $ dycloud function:deploy [--dir <value>] [--service-name <value>] [-n <value>] [--env-params <value>]
    [--int-net-type 0|1|2] [--service-size <value>] [--registry <value>] [--appId <value>] [-i] [--ideVersion <value>]
    [--session <value>] [-i] [--draftSaveNote <value>] [--envId <value>] [--source <value>] [--type <value>] [--env
    <value>] [--channel <value>] [--rewrite-url <value>]

FLAGS
  -i, --coverOnlineDraft   是否覆盖线上草稿
  -i, --isIDE              是否是ide
  -n, --note=<value>       发布备注
  --appId=<value>          appid
  --channel=<value>        channel
  --dir=<value>            发布的代码目录：默认为当前执行命令的文件夹，可指定
  --draftSaveNote=<value>  草稿保存名称
  --env=<value>            env
  --env-params=<value>     环境变量，格式为 aa=bb&cc=dd，注意使用时添加引号 '"'
  --envId=<value>          envId
  --ideVersion=<value>     ide版本
  --int-net-type=(0|1|2)   设置外网出流量，枚举值: 0 = 固定公网IP; 1 = 非固定公网IP; 2 = 关闭
  --registry=<value>       npm 镜像源
  --rewrite-url=<value>    channel
  --service-name=<value>   服务名称
  --service-size=<value>   容器规格
  --session=<value>        session
  --source=<value>         source
  --type=<value>           type
```

## `dycloud function:list`

当前环境下的函数服务列表

```
USAGE
  $ dycloud function:list

EXAMPLES
  $ dycloud function:list
```

## `dycloud function:pull`

命令说明：同步所有的函数服务已发布的线上版本代码。如需下载某函数服务在云端编辑区的草稿代码，请前往控制台目录树区的「...」，点击「另存为草稿版本」后再下载到本地进行手动导入。

```
USAGE
  $ dycloud function:pull [--dir <value>] [--service-name <value>] [-i]

FLAGS
  -i, --cover             跳过同名的函数服务同步：枚举值，是、否。默认为否，此时如果存在与函数服务同名的文件夹则直接跳过
                          同步。值为是时则覆盖同目录文件。
  --dir=<value>           函数服务同步的根目录路径：默认为当前执行命令的文件夹，可指定
  --service-name=<value>  服务名称
```

## `dycloud help [COMMAND]`

Display help for dycloud.

```
USAGE
  $ dycloud help [COMMAND] [-n]

ARGUMENTS
  COMMAND  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for dycloud.
```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.1.11/src/commands/help.ts)_

## `dycloud login`

用户登录

```
USAGE
  $ dycloud login [-i] [-e <value>] [-p <value>] [-l]

FLAGS
  -e, --email=<value>     登录邮箱
  -i, --info              当前用户信息
  -l, --verbose           打印日志
  -p, --password=<value>  登录密码

EXAMPLES
  $ dycloud login
```

## `dycloud logout`

退出登录

```
USAGE
  $ dycloud logout

EXAMPLES
  $ dycloud logout
```

## `dycloud service:build`

根据云端模板在本地创建镜像，支持docker build指令参数透传，详见：https://docs.docker.com/engine/reference/commandline/build/

```
USAGE
  $ dycloud service:build [--service-name <value>]

FLAGS
  --service-name=<value>  服务名称
```

## `dycloud service:deploy`

部署当前环境下的指定服务

```
USAGE
  $ dycloud service:deploy [--service-name <value>] [-n <value>] [-t <value>] [--no-confirm] [--env-params <value>]
    [--service-size 1|2|3]

FLAGS
  -n, --note=<value>      发布备注
  -t, --tag=<value>       镜像版本号
  --env-params=<value>    环境变量，格式为 aa=bb&cc=dd，注意使用时添加引号 '"'
  --no-confirm            跳过二次确认
  --service-name=<value>  服务名称
  --service-size=(1|2|3)  容器规格，枚举值: 1 = 1核 1G; 2 = 2核 2G; 3 = 3核 3G

EXAMPLES
  $ dycloud service:deploy
```

## `dycloud service:info`

部署当前环境下的指定服务

```
USAGE
  $ dycloud service:info [--service-name <value>]

FLAGS
  --service-name=<value>  服务名称

EXAMPLES
  $ dycloud service:info
```

## `dycloud service:list`

当前环境下的服务列表

```
USAGE
  $ dycloud service:list

EXAMPLES
  $ dycloud service:list
```
<!-- commandsstop -->