8base-cli 中文文档教程

Question

8base CLI

注册 8Base 文档主页 入门 8base 计划

8base 命令行界面 (CLI) 可轻松生成自定义功能并直接管理工作区从终端。

我们建议所有开发人员定期查看 8base 社区 论坛，以获取对 8base-cli 包的定期更新和更改。

Installation

安装 8abse-cli 最简单的方法是使用 NPM 并全局安装包：

$ npm install -g 8base-cli

或者，如果您使用的是 Yarn：

$ yarn global add 8base-cli

Getting Started

在使用 8base-cli 之前，您需要对自己进行身份验证。 您可以通过以下两种方式之一执行此操作：

使用以下方式启动浏览器：

$ 8base login

或者，通过 CLI 使用：

$ 8base login --email="my@email.com" --password="myP@ssw0rd"

一旦成功通过身份验证，文件将在 ~/.8baserc 处更新，其中包含经过身份验证的会话的 JSON 负载.

Further Information

有关命令和配置选项的更多信息，请参阅 8base CLI 文档。 您还可以通过对包本身或给定命令运行 --help 来了解 CLI 中的不同命令。

DESCRIPTION
  The 8base Command Line Interface is a unified tool to manage your 8base workspaces services.

USAGE
  8base <command> [OPTIONS]

  Use 8base command `--help` for information on a specific command. Use 8base help topics to view a list of available help topics. The synopsis for each
  command shows it’s parameters and their usage. Optional options are shown in square brackets.

COMMANDS
  8base configure            Allows you to select a default workspace and retrieve the API endpoint URL.
  8base deploy               Deploys project in current directory to 8base using 8base.yml config file. To use this command, you must be in the root directory
                             of your 8base project.
  8base describe [name]      Describes your 8base project’s functions and their types through 8base.yml file.
  8base export               Export current workspace data schema
  8base generate <command>   Generator for server and client side resources                                                                       [aliases: g]
  8base import               Import 8base schema file and data to the current - or specified - workspace.
  8base init                 Initializes a new project with example directory structure and custom functions.
  8base invoke [name]        Invokes a custom function in the production workspace.
  8base invoke-local [name]  Invokes the custom function in the local development workspace.
  8base login                Authenticates the command line user by letting them log into an 8base account.
  8base logout               Clears local login credentials and invalidates API session.
  8base logs [name]          Show logs for the function(s).
  8base package              Package 8base application without deploying it.

OPTIONS
  --version, -v  Show version number                                                                                                                 [boolean]
  --debug, -d    Turn on debug logs                                                                                                                  [boolean]
  --help, -h     Show help

Contributing

与大多数伟大的事物一样，8base CLI 是一项正在进行的工作。 因此，CLI 正在不断改进。 我们的 CLI 在 GitHub 上是公开的和开源的。 因此，无论何时，您都可以：

1. 报告问题 8base 使用 GitHub Issue Tracking 来跟踪问题（主要是错误和新代码的贡献）。 如果您发现了一个错误，这是开始的地方。

2. 解决问题 如果您不仅在 CLI 中发现了问题，而且还找到了解决方案，请提交一个 pull request！

3. 添加功能： 您可以通过添加很棒的功能来帮助改进 8base CLI。 老实说，这是一本打开的书。 如果您认为某事有用，其他人可能也会认为有用。

我们会尽最大努力及时审查、回复和合并所有贡献！