README

A command line utility for working with EspoCRM.

⚠️ Disclaimer ⚠️

This project is not associated with the EspoCRM project nor Letrium LTD. Espo CRM® is a registered trademark of Letrium LTD. Any use by DUBAS S.C. is for referential purposes only and does not indicate any sponsorship, endorsement, or affiliation between Letrium LTD.

Environment requirements

PHP >=8.0.0 with ext-mbstring extension enabled
Composer

Install

Via composer as a local dependency:

composer require --dev dubas/espo-console

OR:

Via composer as a global dependency:

composer global require dubas/espo-console

Running Commands

Depending on install location:

vendor/bin/espo

OR:

espo

Which should get you something like:

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

Roadmap

The project is in its early stages and some feature either are missing or unstable. The things we want to focus on:

Writing unit tests
Backup command
Creating an extension skeleton
Compiling a PHAR file with an ability to self-update

Contributing

Pull requests are welcome. Keep it simple. Keep it minimal. For major changes, please open an issue first to discuss what you would like to change.

Acknowledgements

The project is inspired by other great CLI tools. Some of the commands were ported to PHP from espocrm/ext-template which were written in JavaScript. Commands structure and naming are inspired by wp-cli and concrete5/console. Originally the project was based on mnapoli/silly micro-framework which has provided a handy Application::runCommand method.

Huge thank you to all who are part of the open source community!

License

The MIT License (MIT). Please see License File for more information.

dubas / espo-console

Maintainers

Details