Skip to content

Latest commit

 

History

History
165 lines (136 loc) · 13.7 KB

COMMANDS.md

File metadata and controls

165 lines (136 loc) · 13.7 KB

<-- Back to main section

Commands

Special commands

Command Description
ct self-update Update ct command (download new version)
ct update Updates all system components, ssh configuration, ct command update etc.
ct make Search for "Makefile" in tree and start "make" in this directory

System commands

Command Description
ct shutdown (alias) Shutdown system

Log commands

All log commands are using a grep-filter (specified as optional argument)

Command Description
ct log:mail Shows mail logs

Docker commands

Command Description
ct docker:create Create new docker boilerplate in directory (first argument)
ct docker:create projectname -> Create new docker boilerplate instance in directory "projectname"
ct docker:create projectname --code=[email protected]/foo/bar -> Create new docker boilerplate instance in directory "projectname" and git code repository
ct docker:create projectname --docker=[email protected]/foo/bar -> Create new docker boilerplate instance in directory "projectname" and custom docker boilerplate repository
ct docker:create projectname --code=[email protected]/foo/bar --make=build -> Create new docker boilerplate instance in directory "projectname" and git code repository, will run automatic make (Makefile) task "build" after checkout
ct docker:shell Jump into a shell inside a docker container (using predefined user defined with CLI_USER in docker env)
ct docker:shell -> enter main container
ct docker:shell mysql -> enter mysql container
__ct docker:shell --user=www-data -> enter main container as user www-data
ct docker:root Jump into a shell inside a docker container as root user
ct docker:mysql Jump into a mysql client inside a docker container
ct docker:mysql -> execute mysql client inside main container
ct docker:sniff Start network sniffer for various protocols
ct docker:sniff http -> start HTTP sniffing
ct docker:exec Execute command in docker container
ct docker:exec ps -> run 'ps' inside main container
ct docker:cli Execute special cli command in docker container
ct docker:cli scheduler -> run 'scheduler' in TYPO3 CMS
ct docker:compose Execute docker-compose (recursive up-searching for docker-compose.yml)
ct docker:compose ps -> list all running docker-compose containers

MySQL commands

Command Description
ct mysql:clear Clear database (remove all tables in database)
ct mysql:clear typo3
ct mysql:connections Lists all current connections
ct mysql:create Create (and drops if already exists) a database
ct mysql:create typo3
ct mysql:debug Shows mysql debug log (lists all queries) with basic filter support
ct mysql:debug (full log)
ct mysql:debug tt_content (full log)
ct mysql:slowlog Shows mysql slow log
ct mysql:slowlog (show slow queries with 1 sec and more)
ct mysql:slowlog --time=10 (show slow queries with 10 sec and more)
ct mysql:slowlog --no-index (show not using index and slow (1sec) queries)
ct mysql:drop Drops a database
ct mysql:drop typo3
ct mysql:list Lists all databases with some statitics
ct mysql:restart Restart MySQL server
ct mysql:backup Backup a database to file
Compression type will be detected from file extension (default plain sql)
ct mysql:restore typo3 dump.sql -> plain sql dump
ct mysql:restore typo3 dump.sql.gz -> gzip'ed sql dump
ct mysql:restore typo3 dump.sql.bzip2 -> bzip2'ed sql dump
ct mysql:restore typo3 dump.sql.xz -> xz'ed (lzma'ed) sql dump
ct mysql:restore typo3 dump.sql --filter=typo3 -> No TYPO3 cache tables in dump
ct mysql:restore Create (and drops if already exists) a database and restore from a dump
Dump file can be plaintext, gzip, bzip2 or lzma compressed
and will automatically detected
ct mysql:restore typo3 dump.sql.bz2
ct mysql:convert Convert character set and collation of a database
ct mysql:convert typo3 -> Convert typo3 into UTF-8 with utf8_general_ci
ct mysql:convert typo3 --charset=latin1 -> Convert typo3 into LATIN-1
ct mysql:convert typo3 --collation=utf8_unicode_ci -> Convert typo3 into UTF-8 with utf8_unicode_ci
ct mysql:convert typo3 --stdout -> Print sql statements to stdout

Sync commands

Command Description
ct sync-init Create example clisync.yml in current working directory and open file for editing
ct sync server Search for clisync.yml in tree and start server synchronization (eg. from live or preview to local development instance
ct sync production -> Use "production" configuration and start sync
ct sync preview --rsync -> Use "preview" configuration and start only rsync
ct sync staging --mysql -> Use "staging" configuration and start only mysql sync
ct deploy server Search for clisync.yml in tree and start server deployment (eg. from local development to live or preview environment
ct deploy production -> Use "production" configuration and start deployment
ct deploy preview --rsync -> Use "preview" configuration and start only rsync
ct deploy staging --mysql -> Use "staging" configuration and start only mysql sync
ct share:backup Search for clisync.yml in tree and start backup to shared server
ct share:backup -> Backup files and database from share
ct share:backup --rsync -> Backup only files from share
ct share:backup --mysql -> Backup only database from share
ct share:restore Search for clisync.yml in tree and start restore from shared server
ct share:restore -> Restore files and database from share
ct share:restore --rsync -> Restore only files from share
ct share:restore --mysql -> Restore only database from share

PHP commands

Command Description
ct php:trace Trace syscalls from one or all PHP processes (strace)
ct php:trace --all -> Trace all php processes immediately
ct php:composer Search for "composer.yml" in tree and start "composer" in this directory

Samba commands

Command Description
ct samba:restart Restart Samba server

System commands

Command Description
ct system:env Lists common environment variables
ct system:openfiles Lists current open files count grouped by process
ct system:shutdown Shutdown system
ct system:swap Show swap usage for running processes
ct system:update Updates all system components, ssh configuration, ct command update etc.
ct system:version Shows version for common packages

TYPO3 commands

Command Description
ct typo3:beuser Injects a dev user (pass dev) to all or one specified TYPO3 database
ct typo3:beuser
ct typo3:beuser typo3
ct typo3:cleanup Cleanup command tables to same some table space
ct typo3:cleanup
ct typo3:cleanup typo3
ct typo3:domain Add default suffix to all domains (default: .vm)
ct typo3:domain --baseurl Also update config.baseURL in SetupTS
ct typo3:domain --list Print list of domains and exit
ct typo3:domain --remove='*.vagrantshare.com' Remove all *.vagrantshare.com domains (used by vagrant:share command)
ct typo3:domain --duplicate='foobar.vagrantshare.com' Duplicates all domains and add suffix 'foobar.vagrantshare.com' (used by vagrant:share command)

Vagrant commands

Command Description
ct vagrant:share Start sharing (with some workflow stuff) (ALPHA! not finished!)

User commands

Command Description
ct user:rebuildsshconfig Rebuild SSH config from ct repository (/vagrant/provision/sshconfig)