用于couchdb的交互式命令行shell
cdbcli的Python项目详细描述
功能
- 数据库名称、文档ID、视图名称、命令的自动完成
- 文档和视图的语法突出显示
- 像浏览文件系统一样浏览couchdb服务器
- 支持的各种命令
- CD-更改数据库
- ls-在数据库下列出文档
- cat-显示文档内容
- exec-执行视图
- rm-删除文档
- man-显示命令帮助
- mkdir-创建新数据库
- du-文档和数据库大小
- lv-在视图文档中列出视图
- 使用外部$EDITOR 创建/更新文档
- 管道输出到外部shell命令，例如grep、wc和jq
演示
用法
这个工具允许您像遍历文件系统一样遍历couchdb数据库。支持熟悉的文件系统命令，例如ls、cd、mkdir、rm等，同时提供上下文丰富的自动完成功能。
启动cdbcli
有关如何安装cdbcli的指南，请参阅Installation部分。
运行cdbcli需要连接到要连接到的基础couchdb实例的连接参数。
cdbcli --help Usage: cdbcli [OPTIONS] [DATABASE] Options: -h, --host TEXT The host of the couchdb instance --port TEXT The port of the coouchdb instance -u, --username TEXT The username to connect as -p, --password TEXT The password -P, --askpass / --no-askpass Ask for password? --tls / --no-tls Use TLS to connect to the couchdb instance? --help Show this message and exit.
例如，如果要在http://yourdomain:9999连接couchdb实例，可以发出以下命令：
cdbcli -h yourdomain --port 9999 -u admin -P
指定-P将提示您输入密码。您也可以使用-p在命令行中指定密码，但对于敏感密码，不建议这样做。
默认情况下，cdbcli连接到位于http://localhost:5984的couchdb实例。
您将看到CDBCLI的启动屏幕：
___ ____ ____ ___ __ ____
/ __)( _ \( _ \ / __)( ) (_ _)
( (__ )(_) )) _ <( (__ )(__ _)(_
\___)(____/(____/ \___)(____)(____)
Welcome to cdbcli 0.1.1
CouchDB version: 1.5.0
Type 'help' or 'man' to get a list of all supported commands
Press <TAB> for command auto-completion
Press Ctrl+C or Ctrl+D or type 'exit' to exit
admin@yourdomain/>
与Docker一起运行
cdbcli也可用作docker hub上的docker映像
运行：
docker run -it kevinjqiu/cdbcli cdbcli <arguments>
Docker网络限制适用，因此如果您想连接到本地主机上的数据库，例如，您需要让容器使用主机的网络：
docker run -it --net=host kevinjqiu/cdbcli cdbcli <arguments>
安装
pip install cdbcli
贡献
- 克隆此存储库。
- 制作一个python virtualenv
- 安装要求：pip install -rrequirements-test.txt
- 安装docker，因为集成测试需要它
- 运行make start_couchdb。这将使用docker启动测试couchdb实例
- 运行make test
- 运行make stop_couchdb清理
对文档的贡献
- 克隆此存储库。
- 制作一个python virtualenv
- 安装要求：pip install -rrequirements-docs.txt
- 运行make docs。可以在docs/build/index.html下访问文档。
许可证
cdbcli在apache 2.0下获得许可
归因
- python-prompt-toolkit作者：乔纳森·斯伦兹
- click作者：Armin Ronacher
欢迎加入QQ群-->： 979659372
