Skip to content

Latest commit

 

History

History
118 lines (86 loc) · 3.08 KB

INSTALL.md

File metadata and controls

118 lines (86 loc) · 3.08 KB
Raw

<-- Back to main section

Installation

Requirements

  • PHP 5.5 (CLI) with pcntl module
  • Tools
    • git
    • wget
    • multitail
    • tshark
    • tcpdump
    • ngrep
    • strace
    • lsof
    • sudo
    • moreutils (ifdata)
    • coreutils (grep, sort, uniq, awk, cat, df, ip, cut, lsb_release, wall)
    • rsync (to prevent bugs with umlauts while you have to use rsync with version >= 3.0 (GNU version))
    • gnu-sed
    • docker and docker-compose (if you want to use docker)
    • mysql (if you want to use mysql)

When you're want to using clitools under OSX, you could use homebrew, an excellent package manager to easily install the above mentioned requirements.

Install clitools

# Download latest tools (or in ~/bin if you have it in $PATH)
wget -O/usr/local/bin/ct https://www.achenar.net/clicommand/clitools.phar

# Set executable bit
chmod 777 /usr/local/bin/ct

# MacOS/Linux: example configuration for Docker VM
wget -O"$HOME/.clitools.ini" https://github.com/webdevops/clitools/blob/develop/Documentation/Examples/macos-docker-clitools.ini

Aliases

Now you can use some useful aliases (some aliases requires clitools 1.8.0!):

Example aliases for clitools

Configuration

CliTools will read /etc/clitools.ini (system wide) and ~/.clitools.ini (personal) for configuration

The default configuration is inside the phar.

Docker specific configuration

[config]
; ssh_conf_path   = "/vagrant/provision/sshconfig/"

[db]
dsn = "mysql:host=127.0.0.1;port=13306"
username = "root"
password = "dev"
debug_log_dir = "/tmp/debug/"

[syscheck]
enabled = 1
wall = 1
diskusage = 85

[commands]
; not used commands here
ignore[] = "CliTools\Console\Command\Log\ApacheCommand"
ignore[] = "CliTools\Console\Command\Log\PhpCommand"
ignore[] = "CliTools\Console\Command\Log\DebugCommand"
ignore[] = "CliTools\Console\Command\Apache\RestartCommand"
ignore[] = "CliTools\Console\Command\Mysql\RestartCommand"
ignore[] = "CliTools\Console\Command\Php\RestartCommand"
ignore[] = "CliTools\Console\Command\System\UpdateCommand"
ignore[] = "CliTools\Console\Command\System\RebootCommand"

Update clitools

# Stable channel
ct self-update

## Beta channel
ct self-update --beta

## Fallback update (if GitHub fails)
ct self-update --fallback

Install clitools from source (You don't have to perform any tasks of the default installation procedure)

# Clone the repository
git clone https://github.com/webdevops/clitools clitools

# cd into cloned repository
cd clitools

# run all makefile tasks which are necessary for building and installing from source
make all

Details about the Makefile

If you take a look into the Makefile, you will see which tasks have been executed. The steps are:

  1. Execute composer command
  2. Start main build script
  3. Copy the previously built phar file to /usr/local/bin, so that you can execute clitools just by typing ct.

Note: If you want to compile clitools in OSX by your own, use the homebrew package manager: brew install coreutils g-sed homebrew/php/box.