electric-db-cli 0.0.3

 [](LICENSE.md) [](https://circleci.com/gh/electric-db/electric-cli/tree/main)

# Electric DB CLI

Electric DB CLI 是 [Electric DB](https://electricdb.net) 地理分布式数据库托管服务的命令行接口工具。它使用 Python 开发，代码在 [github.com/electric-db/electric-cli](https://github.com/electric-db/electric-cli) 上以 [MIT 许可协议](https://github.com/electric-db/electric-cli/blob/master/LICENSE) 发布。

## 开发

您可以通过将依赖项安装到 Python3 环境中并开发 egg 来安装 CLI 以进行本地开发。

`sh pip install -r requirements.txt python setup.py develop `

这将将在您的本地 Python 环境的 bin 文件夹中安装一个 electric 二进制文件。您可以使用例如以下命令检查它是否在您的路径上。

`sh which electric `

## 构建

如果您想构建独立的二进制文件，您首先需要安装额外的开发需求。

`sh pip install -r dev-requirements.txt `

然后您可以使用以下命令使用 [Pex](https://pex.readthedocs.io) 可执行文件进行构建。

`sh python setup.py bdist_pex --bdist-all `

这将创建一个位于 ./dist/electric 的二进制文件，您可以将其复制并在任何系统上运行。

或者，您可以使用 [PyOxidizer](https://pyoxidizer.readthedocs.io) 来构建一个包含嵌入式 Python 解释器的独立二进制文件。

`sh pyoxidizer run `

这将创建一个位于 ./build/:target/debug/install/electric 的二进制文件，您可以在与构建机器相同架构和操作系统的任何机器上运行它。

## 使用方法

运行不带参数的 electric 命令或带有 –help 标志的命令以获取使用信息

`sh electric --help `

您可以深入了解资源/命令组以及单个命令的使用信息，例如。

`sh electric auth --help electric auth login --help `

更详细的[文档可在 Electric DB 网站上找到](https://electricdb.net/docs)。

## 测试

运行测试需要 nose 和 coverage，它们包含在 dev-requirements.txt 中。

然后，运行例如：

`sh nosetests --with-coverage --cover-package electric `