README

用于操作 EspoCRM 的命令行工具。

⚠️ 注意声明 ⚠️

此项目与 EspoCRM 项目或 Letrium LTD 无关。 Espo CRM® 是 Letrium LTD 的注册商标。DUBAS S.C. 的任何使用仅用于参考目的，并不表示任何赞助、认可或与 Letrium LTD 的关联。

环境要求

• PHP >=8.0.0 并启用 ext-mbstring 扩展
• Composer

安装

作为本地依赖项通过 composer

composer require --dev dubas/espo-console

OR

作为全局依赖项通过 composer

composer global require dubas/espo-console

运行命令

根据安装位置

vendor/bin/espo

OR

espo

应该会得到类似的结果

Dubas\Console 0.0.16

Usage:
  command [options] [arguments]

Options:
  -h, --help                     Display help for the given command. When no command is given display help for the list command
  -q, --quiet                    Do not output any message
  -V, --version                  Display this application version
      --ansi|--no-ansi           Force (or disable --no-ansi) ANSI output
  -n, --no-interaction           Do not ask any interactive question
  -d, --working-dir=WORKING-DIR  If specified, use the given directory as working directory [default: "/var/www/default"]
  -I, --instance=INSTANCE        Path to EspoCRM instance [default: "site"]
  -v|vv|vvv, --verbose           Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Available commands:
  completion            Dump the shell completion script
  help                  Display help for a command
  list                  List commands
 admin
  admin:clear-cache     [cc] Clear all backend cache
  admin:rebuild         [rb] Rebuild backend and clear cache
 config
  config:create         Create config
  config:merge          Merge configs
 core
  core:download         Download core EspoCRM files
  core:install          Run the standard EspoCRM installation process
 db
  db:create             Create database
  db:drop               Delete database
  db:query              Executes a SQL query against the database
 ext
  ext:build             Build an installable extension package
  ext:composer-install  Composer dependencies for an extension
  ext:copy              Copy extension files to EspoCRM instance
  ext:init              Setup a complete environment for developing an extension
  ext:install           Install a single or multiple EspoCRM extensions
  ext:npm-install       Install Node.js dependencies for an extension
  ext:path              Return path to the backend directory
 import
  import:test-data      Import test data

开发路线图

项目处于早期阶段，一些功能可能缺失或不稳定。我们想要关注的事情

• 编写单元测试
• 备份命令
• 创建扩展骨架
• 编译具有自我更新能力的 PHAR 文件

贡献

欢迎拉取请求。保持简单。保持最小化。对于重大更改，请首先打开一个问题来讨论您想要更改的内容。

致谢

该项目灵感来自其他优秀的 CLI 工具。一些命令是从用 JavaScript 编写的 espocrm/ext-template 端口移植到 PHP 的。命令结构和命名灵感来自 wp-cli 和 concrete5/console。最初该项目基于 mnapoli/silly 微框架，该框架提供了一个方便的 Application::runCommand 方法。

向所有开源社区成员表示衷心的感谢！

许可证

MIT 许可证 (MIT)。有关更多信息，请参阅 许可证文件。