magento-cli

README

magento-cli

Documentation | Discussions | Twitter | Contribution Guide

Running magento and adobe commerce locally with a cli tool

Installation

Binaries are compiled with every release, you can grab it from the releases page, and use it as-is. These files are fit to be ran directly, from $PATH, or even committed i.e. /path/to/iac-repo/bin/magento-cli and invoked with cd /path/to/iac-repo/ && bin/magento-cli.

Homebrew

Installing with brew is the preferred way to install for most use-cases. Homebrew installs the tool globally, and is updated with every release.

    brew tap blueacorninc/magento-cli
    brew install magento-cli

Compiling From Source

If you prefer to compile from source, the Makefile can be used:

    git clone git@github.com:blueacorninc/magento-cli.git 
    cd magento-cli
    make install # runs `go build .` and copies to /usr/local/bin

Running Source Locally

    cd example/
    composer install
    go run .. serve

PHP Concurrency

Exporting the following will peg you to a specific version of php for your instance, using homebrew. This is a makeshift approach, in the future the tool will abstract this away for you.

export MAGECLI_PHP_VERSION=8.1.6
export MAGECLI_PHP_BIN=/opt/homebrew/Cellar/php/$MAGECLI_PHP_VERSION/bin/
export PATH=$MAGECLI_PHP_BIN:$PATH%

Contributing

For a complete guide to contributing to magento-cli, see the Contribution Guide

Bug reports and pull requests are welcome on GitHub at https://github.com/blueacorninc/magento-cli/issues.

License

Mach is released under the MIT License

Author Information

This project was started in 2022 by Doug Hatcher doug.hatcher@blueaornici.com.

Documentation

Overview

Magento-cli a cli application for managing local magneto instances

Magento-cli provides a wrapper for the bin/magento command in a directory, and is intended to provide convenience commands like `serve` and `sql` leveraging the local php web server, or docker-compose. If it doesn't match a command, it will pass through the command to the `bin/magento` command, providing a nice workflow around this tool.