Bitrix Console Commands

Bitrix Console Commands

All CLI operations are performed via bitrix.php from the /bitrix/ folder:

cd /path/to/document_root/bitrix
php bitrix.php list                   # list all commands
php bitrix.php help <command>         # help for a command
php bitrix.php <command> [args] -n    # -n = no-interaction

Requires configured Composer (usually /local/composer.json + composer install → /local/vendor/).

Configure Composer path in .settings.php:

'composer' => [
    'value' => ['config_path' => '../composer.json'],
    'readonly' => true,
],

Keep composer.json outside DOCUMENT_ROOT when possible.

Code Generators (make:*)

Since main 25.900. On older versions, scaffold files manually using skill examples.

Commands are interactive but support -n and mandatory parameters.

make:component name format is namespace:component_name (e.g. my:user.card). The part before the colon is the component namespace (folder under components/), not a PHP namespace. If omitted, the command uses bitrix. Placement rule: any non-bitrix namespace lands under /local/ even without --local; --local forces /local/ for the bitrix namespace too. Without --no-module the component goes into a module's install/components/ (module id from --module, default — the part of the name before the first dot). Extra options: --root (target document root), --show (print without writing).

Placement / naming options (where the generator supports them):

Non-interactive Call Example:

php bitrix.php make:controller Post -m vendor.blog --actions=crud -n
php bitrix.php make:tablet blog_post vendor.blog -n
php bitrix.php orm:annotate -m vendor.blog

After make:module, add .settings.php, /lib/, routes, etc. yourself or via further make:* / dev:module-skeleton.

dev:locator-codes vendor.module writes /local/modules/vendor.module/.phpstorm.meta.php (or /bitrix/modules/<id>/ if that path exists). --show prints to stdout without saving (php bitrix.php dev:locator-codes vendor.module --show > ./phpstorm.meta.php).

Built-in Utility Commands

• orm:annotate [-m modules] [--clean] — generates PHPDoc annotations for ORM entities for IDE autocompletion.
• messenger:consume [queues...] [--sleep N] [--time-limit N] — message queue processing. Queue names are separate arguments (messenger:consume first second), not a comma-separated string. There is no CLI --limit in main 26.650.100 (the option is commented out in the command); batch size is the queue config key limit. Requires messenger.run_mode = cli. Can be run via cron or Supervisor.
• translate:index [--path=...] — indexing translations. Requires the translate module installed and loaded.
• update:modules [-m modules], update:versions <file.json>, update:languages [-l codes] — updates.

Custom Console Command

CLI loads commands from installed modules only: it reads each module's .settings.php → console.commands and does new $commandClass(). There is no constructor DI. Global /local/.settings.php is not a source of console.commands.

1. Inherit from Symfony\Component\Console\Command\Command, place files in /lib/Cli/Command/<Domain>/.

   namespace Vendor\Module\Cli\Command\Feature;
   
   use Bitrix\Main\DI\ServiceLocator;
   use Symfony\Component\Console\Attribute\AsCommand;
   use Symfony\Component\Console\Command\Command;
   use Symfony\Component\Console\Input\InputInterface;
   use Symfony\Component\Console\Input\InputOption;
   use Symfony\Component\Console\Output\OutputInterface;
   use Vendor\Module\Application\Service\RebuildService;
   
   #[AsCommand(name: 'feature:rebuild', description: 'Rebuild feature cache')]
   final class RebuildCommand extends Command
   {
       protected function configure(): void
       {
           $this->addOption('limit', 'l', InputOption::VALUE_OPTIONAL, 'Batch size', 1000);
           $this->addOption('dry-run', null, InputOption::VALUE_NONE);
       }
   
       protected function execute(InputInterface $input, OutputInterface $output): int
       {
           $limit = (int)$input->getOption('limit');
           $output->writeln("<info>Rebuilding, limit={$limit}</info>");
   
           try
           {
               /** @var RebuildService $service */
               $service = ServiceLocator::getInstance()->get(RebuildService::class);
               $service->rebuild($limit, (bool)$input->getOption('dry-run'));
   
               return Command::SUCCESS;
           }
           catch (\Throwable $e)
           {
               $output->writeln("<error>{$e->getMessage()}</error>");
               return Command::FAILURE;
           }
       }
   }
   

2. Register the command in /local/modules/vendor.module/.settings.php (module must be installed):

   return [
       'console' => [
           'value' => [
               'commands' => [
                   \Vendor\Module\Cli\Command\Feature\RebuildCommand::class,
               ],
           ],
           'readonly' => true,
       ],
   ];
   

   Section is named console, key is commands. Old name cli should not be used for new modules.

3. After this, the command will appear in php bitrix.php list. Set the name with #[AsCommand(name: '...')] or $this->setName() in configure() — the kernel does new $commandClass() and does not derive the name from the PHP namespace.

Running via Cron

www/bitrix/bitrix.php computes DOCUMENT_ROOT from getcwd() + SCRIPT_NAME. Run from the document root or from /bitrix/, not via an absolute php /.../bitrix.php from an unrelated cwd.

# Every 5 minutes — queue processing
*/5 * * * * cd /var/www/site/bitrix && php bitrix.php messenger:consume --sleep=1 --time-limit=270 --no-interaction

# Every hour — feature cache cleanup
0 * * * *   cd /var/www/site/bitrix && php bitrix.php feature:rebuild --no-interaction

Equivalent: cd /var/www/site && php bitrix/bitrix.php .... Always use --no-interaction in cron.

Checklist for a Good Command

• Descriptive name (feature:rebuild, not do-stuff).
• All parameters — via InputArgument/InputOption, not global variables.
• Returns Command::SUCCESS/Command::FAILURE/Command::INVALID.
• Logs and progress go to OutputInterface, errors — to stderr via $output->getErrorOutput().
• Long logic lives in a service; command is a thin wrapper that resolves the service via ServiceLocator::get() in execute().
• Command class has no constructor DI — CLI does new $commandClass().
• Registered in an installed module's console.commands, not in global /local/.settings.php.
• In case of a fatal error, exception is logged and converted to FAILURE.