PHPackages kohkimakimoto/altax - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [DevOps & Deployment](/categories/devops) 4. / 5. kohkimakimoto/altax ActiveLibrary[DevOps & Deployment](/categories/devops) kohkimakimoto/altax =================== Altax is an extensible deployment tool for PHP. v3.0.17(8y ago)2002.8k11[2 issues](https://github.com/kohkimakimoto/altax/issues)1Apache-2.0PHPPHP >=5.3.0 Since Jun 27Pushed 8y ago15 watchersCompare [ Source](https://github.com/kohkimakimoto/altax)[ Packagist](https://packagist.org/packages/kohkimakimoto/altax)[ Docs](https://github.com/kohkimakimoto/altax)[ RSS](/packages/kohkimakimoto-altax/feed)WikiDiscussions master Synced 4w ago READMEChangelog (6)Dependencies (9)Versions (38)Used By (1) Altax ===== [](#altax) [![Build Status](https://camo.githubusercontent.com/78987deada0228e6e398d11b84bf5d7672165f9c9261fba7da8280f45e41d89e/68747470733a2f2f7472617669732d63692e6f72672f6b6f686b696d616b696d6f746f2f616c7461782e706e673f6272616e63683d6d6173746572)](https://travis-ci.org/kohkimakimoto/altax)[![Coverage Status](https://camo.githubusercontent.com/477cdfd03952b4b2cfd9bc9cd4b07fde48ae41411f2cb9fcd3df1ffe84b88979/68747470733a2f2f636f766572616c6c732e696f2f7265706f732f6b6f686b696d616b696d6f746f2f616c7461782f62616467652e706e673f6272616e63683d6d6173746572)](https://coveralls.io/r/kohkimakimoto/altax?branch=master)[![Latest Stable Version](https://camo.githubusercontent.com/fe9ac956277b7905796e4724869e5b8f120b28a8a9aad1f81beb3f269ed8d538/68747470733a2f2f706f7365722e707567782e6f72672f6b6f686b696d616b696d6f746f2f616c7461782f762f737461626c652e706e67)](https://packagist.org/packages/kohkimakimoto/altax)[![License](https://camo.githubusercontent.com/d3bbba0036ac92fd0ed68bf7b3b2d9dd3cda6de50b8ff6db1488ad7a5f823df4/68747470733a2f2f706f7365722e707567782e6f72672f6b6f686b696d616b696d6f746f2f616c7461782f6c6963656e73652e706e67)](https://packagist.org/packages/kohkimakimoto/altax) Altax is a deployment tool for PHP. I designed it as a command-line tool for running tasks to remote servers like the [Capistrano](https://github.com/capistrano/capistrano), [Fabric](http://fabric.readthedocs.org/) and [Cinamon](https://github.com/kentaro/cinnamon). It also has a plugin mechanism for managing and installing tasks easily. This is a simple git deploy task definition. You can write any tasks in PHP. ``` // Register managed nodes to a role. Server::node("web1.example.com", "web"); Server::node("web2.example.com", "web"); Server::node("db1.example.com", "db"); // Register a task. Task::register("deploy", function($task){ $appDir = "/path/to/app"; // Execute parallel processes for each nodes. $task->exec(function($process) use ($appDir){ // Run a command remotely and get a return code. if ($process->run("test -d $appDir")->isFailed()) { $process->run("git clone git@github.com:path/to/app.git $appDir"); } else { $process->run(array( "cd $appDir", "git pull", )); } }, array("web")); }); ``` You can run it like below ``` $ altax deploy [web1.example.com:8550] Run: test -d /var/tmp/altax [web1.example.com:8550] Run: git clone git@github.com:kpath/to/app.git /path/to/app Initialized empty Git repository in /path/to/app/.git/ [web2.example.com:8551] Run: test -d /var/tmp/altax [web3.example.com:8551] Run: git clone git@github.com:kpath/to/app.git /path/to/app Initialized empty Git repository in /path/to/app/.git/ ``` You can get more information at . Requirement ----------- [](#requirement) PHP5.3 or later. Installation ------------ [](#installation) I recommend you to install Altax as a phar (PHP Archive) which compiled to single executable file. Run the below command to get latest version of Altax. ``` $ curl -L https://raw.githubusercontent.com/kohkimakimoto/altax/master/installer.sh | bash -s system ``` You will get `altax` command file to `/usr/local/bin` directory. In order to check installation, execute just `altax` command. ``` $ altax Altax version 3.0.0 Altax is a extensible deployment tool for PHP. Copyright (c) Kohki Makimoto Apache License 2.0 ... ``` Usage ----- [](#usage) I describe basic usage in this section. Run `altax init` command to generate first configuration. ``` $ altax init Created file: /path/to/your/directory/.altax/config.php Created file: /path/to/your/directory/.altax/composer.json Created file: /path/to/your/directory/.altax/.gitignore ``` Created `.altax/config.php` file in your current directory is a main configuration file for altax. You can modify this file to define tasks and servers you managed. So now, add the following code in the file. ``` Task::register("hello", function($task){ $task->writeln("Hello world!"); })->description("This is a first sample task."); ``` This is a simple task definition. Defined task is listed by executing just `altax` command. ``` $ altax Altax version 3.0.0 Altax is a deployment tool for PHP. it's designed as a command-line tool for running tasks to remote servers. Copyright (c) Kohki Makimoto Apache License 2.0 ... Available commands: hello This is a first sample task. ... ``` `hello` task you defined can be executed by `altax` command with task name like the followiing. ``` $ altax hello Hello world! ``` You got a first altax task now! If you want to see more information, visit a [documentation](http://kohkimakimoto.github.io/altax/) page. Documentation ------------- [](#documentation) See [documentation](http://kohkimakimoto.github.io/altax/) page. Plugins ------- [](#plugins) Altax has a extensible plugin mechanism. It makes adding functionality easy. Plugins are stored at [Packagist](https://packagist.org/) and installed using [composer](https://getcomposer.org/). As Altax includes embedded composer, you can install plugins by altax command. For instance, if you use PHP5.4 and MySQL database in your product, you can use [Adminer](http://www.adminer.org/) database management tool via Altax plugin. Edit your `.altax/composer.json` file like the following. ``` { "require": { "kohkimakimoto/altax-adminer": "dev-master" } } ``` And run altax update command which is a wrapper command of `composer update` for Altax. ``` $ altax update ``` Adminer altax plugin will be installed in your `.altax/vendor` directory. In order to register the plugin to your task, add the following line your `.altax/config.php` file. ``` Task::register('adminer', 'Altax\Contrib\Adminer\Command\AdminerCommand'); ``` Run the registered plugin task commnad. ``` $ altax adminer ``` Altax runs adminer on built-in web server. So you can use adminer at `http://localhost:3000/`. If you are interested in Altax plugins, [Search plugins at packagist](https://packagist.org/search/?q=altax)! Author ------ [](#author) Kohki Makimoto License ------- [](#license) Apache License 2.0 See [LICENSE](./LICENSE) Previous version ---------------- [](#previous-version) If you use Altax version 2. You can see **[2.x branch](https://github.com/kohkimakimoto/altax/tree/2.x)**. Altax version 1 is no longer maintained. ### Health Score 40 — FairBetter than 86% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity34 Limited adoption so far Community24 Small or concentrated contributor base Maturity70 Established project with proven stability Bus Factor1 Top contributor holds 94.4% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~47 days Recently: every ~220 days Total 35 Last Release 3144d ago Major Versions v1.3.1 → v2.0.02013-09-27 2.x-dev → v3.0.02014-02-25 3.0.x-dev → 4.0.x-dev2014-11-07 PHP version history (2 changes)v1.2.0PHP >=5.3.0 4.0.x-devPHP >=5.4.0 ### Community Maintainers ![](https://www.gravatar.com/avatar/232e612dbf32e70978372a2249e28dd037f75eadafc547913375708571c65f9a?d=identicon)[kohkimakimoto](/maintainers/kohkimakimoto) --- Top Contributors [![kohkimakimoto](https://avatars.githubusercontent.com/u/761462?v=4)](https://github.com/kohkimakimoto "kohkimakimoto (452 commits)")[![pitpit](https://avatars.githubusercontent.com/u/283481?v=4)](https://github.com/pitpit "pitpit (7 commits)")[![gyohk](https://avatars.githubusercontent.com/u/626424?v=4)](https://github.com/gyohk "gyohk (6 commits)")[![markkimsal](https://avatars.githubusercontent.com/u/54099?v=4)](https://github.com/markkimsal "markkimsal (6 commits)")[![ngyuki](https://avatars.githubusercontent.com/u/1871654?v=4)](https://github.com/ngyuki "ngyuki (4 commits)")[![stekycz](https://avatars.githubusercontent.com/u/865447?v=4)](https://github.com/stekycz "stekycz (2 commits)")[![PiranhaGeorge](https://avatars.githubusercontent.com/u/203654?v=4)](https://github.com/PiranhaGeorge "PiranhaGeorge (1 commits)")[![dautushenka](https://avatars.githubusercontent.com/u/7254705?v=4)](https://github.com/dautushenka "dautushenka (1 commits)") --- Tags sshdeploydeploymentaltax ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/kohkimakimoto-altax/health.svg) ``` [![Health](https://phpackages.com/badges/kohkimakimoto-altax/health.svg)](https://phpackages.com/packages/kohkimakimoto-altax) ``` ### Alternatives [shopware/platform The Shopware e-commerce core 3.4k1.5M3](/packages/shopware-platform)[shopware/core Shopware platform is the core for all Shopware ecommerce products. 585.4M534](/packages/shopware-core)[friendsoftypo3/content-blocks TYPO3 CMS Content Blocks - Content Types API | Define reusable components via YAML 103519.9k45](/packages/friendsoftypo3-content-blocks)[sylius/sylius E-Commerce platform for PHP, based on Symfony framework. 8.5k5.9M719](/packages/sylius-sylius)[pimcore/pimcore Content & Product Management Framework (CMS/PIM/E-Commerce) 3.8k3.8M482](/packages/pimcore-pimcore)[jolicode/castor A lightweight and modern task runner. Automate everything. In PHP. 54642.4k4](/packages/jolicode-castor) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)