Windows 系统用户请确保安装 Node.js 在系统盘 C 盘,否则命令行工具无法正常运行。
安装和更新请使用下列命令:
sudo npm install -g avoscloud-code
如果从 npm 安装失败,可以从 GitHub 安装:
sudo npm install -g git+https://github.com/leancloud/avoscloud-code-command
详情查看 changelog.md
- 2015-05-29 发布 v0.7.5,支持 LeanEngine Python 运行时项目的部署;修复 项目类型检测处理不正确的 Bug。
- 2015-05-28 发布 v0.7.4,修复 new 命令提示不在项目目录的 Bug。
- 2015-05-28 发布 v0.7.3,修复 app add 命令在 LeanEngine 项目目录没有关联应用时执行报错的 Bug。
- 2015-05-25 发布 v0.7.2,支持 LeanEngine Node.js 运行时项目的部署;中文化提示信息等。
- 2015-05-16 发布 v0.7.1,修复关闭 _File 创建权限后无法本地部署云代码的 Bug。
- 2015-05-05 发布 v0.7.0,改进部署日志和错误信息提示,增加
--debug
开关等。 - 2015-03-02 发布 v0.6.8,紧急修复调试界面
- 2015-02-26 发布 0.6.7,一些 Bug 修复
- 2015-02-16 发布 0.6.5,nodemon 只监视
cloud
目录,增加升级变更提示,修复无法运行在 io.js 等 Bug。 - 2015-02-13 发布 0.6.4,增加 lint 命令,增加
AV.Cloud.onLogin
hook 等。
为了方便本地运行和调试云代码,请遵照下列步骤进行:
- 要在本地调试云代码,你需要安装 Node.js 最新版本。
- 运行命令:
sudo npm install -g avoscloud-code
安装调试 SDK。以后更新升级也请执行此命令。 - 在项目根目录运行
avoscloud
,将启动本地调试服务器。 - 访问 localhost:3000 即可访问到你的云主机代码,子路径按照你在
app.js
里配置的即可访问。 - 访问 localhost:3000/avos 调试云代码函数和 class hook 函数等。
avoscloud -h
输出:
Usage: avoscloud [选项] <命令>
有效的命令列表包括:
deploy: 部署云代码到 AVOS Cloud 平台开发环境
undeploy: 从 AVOS Cloud 平台清除云代码部署,包括生产环境和开发环境
status: 查询当前部署状态
search <keyword>: 根据关键字查询开发文档
publish: 发布开发环境代码到生产环境
new: 创建云代码项目
logs: 查看云代码日志
clear: 清除本地状态,在输入 app id 或者 master key 错误的情况下使用
upload <file-or-directory>: 导入文件到 AVOS Cloud 平台,如果是目录,则会将该目录下的文件递归导入。
app [list]: 显示当前应用,deploy、status 等命令运行在当前应用上,如果加上 list ,则显示所有的应用信息。
checkout <app>: 切换到一个应用,deploy、status 等命令将运行在该应用上。
add <app>: 添加一个应用。
rm <app>: 移除一个应用。
lint: 静态检查代码错误。
cql: 进入 CQL 查询交互。
Options:
-h, --help output usage information
-V, --version output the version number
-f, --filepath <path> 本地云代码项目根路径,默认是当前目录。
-g, --git 使用定义在管理平台的 git 仓库或者 -u 指定的 git 仓库部署云代码,默认使用本地代码部署。
-p, --project <app> 命令运行在指定应用上,默认运行在当前应用或者 origin 应用上。
-l, --local 使用本地代码部署云代码,该选项是默认选中。
-o, --log <log> 本次部署的提交日志,仅对从本地部署有效。
-n, --lines <lines> 查看多少行最新的云代码日志,默认 10 行。
-t, --tailf 自动刷新云代码日志,结合 logs 命令使用。
-r, --revision <revision> git 的版本号,仅对从 git 仓库部署有效。
并且本工具具有代码热加载功能。修改代码后,无需重启即可以调试最新代码。
下载 avoscloud_completion.sh 保存到某个目录,例如保存为 ~/.avoscloud_completion.sh
,然后在 .bashrc
或者 .bash_profile
文件中添加:
source ~/.avoscloud_completion.sh
重启终端 bash,或者重新加载 profile 文件,就可以让 avoscloud
命令拥有自动完成功能。
参考 云代码命令行工具使用详解
你也可以通过 cURL 工具来调试代码:
- 测试函数:
curl -X POST -H 'Content-Type:application/json' \
-d '{ "name": "dennis"}' \
http://localhost:3000/avos/hello
其中 hello 是你通过 AV.Cloud.define
定义的函数名称。
- 测试
beforeSave
、afterSave
、afterUpdate
、beforeDelete
、afterDelete
等:
curl -X POST -H 'Content-Type:application/json' \
-d '{ "name": "dennis"}' \
http://localhost:3000/avos/MyUser/beforeSave
其中 MyUser
是 className,beforeSave
指定调用 MyUser
定义的 beforeSave
函数,其他函数类似。
部署、发布、清除部署等命令在第一次运行的时候要求用户输入应用的 master key,您可以在 LeanCloud 平台的应用设置里找到 master key。
输入后,本命令行工具将这个应用信息记录在 ~/.avoscloud_keys
文件中(0600 文件权限模式)。
如果您输入错误的 master key 或者在公共机器上运行本命令行工具,可手工删除该文件。
感谢下列用户提交的 Patch:
- License: GNU LGPL.
- Author: LeanCloud.cn (support@leancloud.cn)