Loading...
 

Console

New in Tiki11, Tiki Console is to administer your Tiki instance via the command line. It is based on Symfony's Console Component.

php console.php

user@server:/www/tiki18$ php console.php
Console Tool

Usage:
  command [options] [arguments]

Options:
  -h, --help             Display this help message
  -q, --quiet            Do not output any message
  -V, --version          Display this application version
      --ansi             Force ANSI output
      --no-ansi          Disable ANSI output
  -n, --no-interaction   Do not ask any interactive question
      --site=SITE        Multi-Tiki instance
      --as-user=AS-USER  Run the command as a different user
  -v|vv|vvv, --verbose   Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Available commands:
  help                       Displays help for a command
  list                       Lists commands
  patch                      Apply a specific database schema patch
 addon
  addon:install              Apply profiles for addon
  addon:remove               Remove objects created by addon profile creation
  addon:upgrade              Upgrade profiles for addon to newer version
 backup
  backup:files               Create a backup of Tiki instance files
 cache
  cache:clear                Clear Tiki caches
 daily-report
  daily-report:send          Send daily user reports
 database
  database:backup            Create a database backup (with mysqldump)
  database:configure         Database: Configure (write local.php)
  database:install           Clean Tiki install
  database:redact            Command not available
  database:update            Update the database to the latest schema
 faker
  faker:tracker              Generate tracker fake data
 files
  files:batchupload          Batch upload files into the file galleries
  files:check                Detect orphan or extra files
  files:copy                 Copy files from file galleries to a regular directory on the file system
  files:deleteold            Remove expired files which were uploaded using the deleteAfter option
  files:move                 Move files from file galleries to a regular directory on the file system
 gallery
  gallery:migrate            Migrate images from the Image Gallery to the File Gallery
 goal
  goal:check                 Reviews all active goals and assigns rewards.
 index
  index:catch-up             Catch-up on incremental indexing.
  index:optimize             Optimize the unified search index
  index:rebuild              Fully rebuild the unified search index
 installer
  installer:lock             Disable the installer
 less
  less:compile               Compile LESS theme files into CSS
 list
  list:execute               Performs Plugin ListExecute command on a particular page
 mail-in
  mail-in:poll               Read the mail-in messages
 mail-queue
  mail-queue:send            Send the messages stored in the Mail Queue
 multitiki
  multitiki:list             List MultiTikis in a path
  multitiki:move             Moves a MultiTiki site from one tiki instance to another
 notification
  notification:digest        Send out email notification digests
 plugin
  plugin:approve             Approve a list of plugin invocations/calls
  plugin:list                List all plugin invocations/calls
  plugin:refresh             Parses all the pages to refresh the list of plugin invocations/calls
 preferences
  preferences:delete         Delete a preference
  preferences:get            Get a preference
  preferences:rebuild-index  Fully rebuild the preferences index
  preferences:set            Set a preference
 profile
  profile:apply              Apply a profile
  profile:baseline           Generate the SQL patch to assign profile symbols for an existing installation.
  profile:export:init        Initialize profile export for current site.
  profile:forget             Forget a profile installation
 recommendation
  recommendation:batch       Identify and send recommendations
 rss
  rss:clear                  Clear incoming RSS feed cache
  rss:refresh                Refresh incoming RSS feeds
 scheduler
  scheduler:heal             Heal scheduled tasks
  scheduler:run              Run scheduled tasks
 sitemap
  sitemap:generate           Generate sitemap
 tracker
  tracker:clear              Clear all items from a tracker without warning or notifications. Use with care!
  tracker:import             Import a CSV file into a tracker using a tracker tabular format
 users
  users:list                 Display the list of users in the system
  users:password             Set the password to a given user

user@server:/www/tiki15$ php console.php

Console Tool

Usage:
  [options] command [arguments]

Options:
  --help           -h Display this help message.
  --quiet          -q Do not output any message.
  --verbose        -v|vv|vvv Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
  --version        -V Display this application version.
  --ansi              Force ANSI output.
  --no-ansi           Disable ANSI output.
  --no-interaction -n Do not ask any interactive question.
  --site              Multi-Tiki instance
  --as-user           Run the command as a different user

Available commands:
 help                   Displays help for a command
 list                   Lists commands
addon
 addon:install          Apply profiles for addon
 addon:remove           Remove objects created by addon profile creation
 addon:upgrade          Upgrade profiles for addon to newer version
backup
 backup:files           Create a backup of Tiki instance files
cache
 cache:clear            Clear Tiki caches
daily-report
 daily-report:send      Send daily user reports
database
 database:backup        Create a database backup (with mysqldump)
 database:configure     Database: Configure (write local.php)
 database:install       Clean Tiki install
 database:redact        Command not available
 database:update        Update the database to the latest schema
files
 files:batchupload      Batch upload files into the file galleries
 files:deleteold        Remove expired files which were uploaded using the deleteAfter option
goal
 goal:check             Reviews all active goals and assigns rewards.
index
 index:catch-up         Catch-up on incremental indexing.
 index:optimize         Optimize the unified search index
 index:rebuild          Fully rebuild the unified search index
 index:rebuild --log  Fully rebuild the unified search index with log output
less
 less:compile           Compile LESS theme files into CSS
mail-in
 mail-in:poll           Read the mail-in messages
mail-queue
 mail-queue:send        Send the messages stored in the Mail Queue
multitiki
 multitiki:list         List MultiTikis in a path
 multitiki:move         Moves a MultiTiki site from one tiki instance to another
notification
 notification:digest    Send out email notification digests
profile
 profile:apply          Apply a profile
 profile:baseline       Generate the SQL patch to assign profile symbols for an existing installation.
 profile:export:init    Initialize profile export for current site.
 profile:forget         Forget a profile installation
recommendation
 recommendation:batch   Identify and send recommendations
rss
 rss:refresh            Refresh incoming RSS feeds
tracker
 tracker:clear          Clear all items from a tracker without warning or notifications. Use with care!
 tracker:import         Import a CSV file into a tracker using a tracker tabular format

user@server:/www/trunk$ php console.php

Console Tool

Usage:
  [options] command [arguments]

Options:
  --help           -h Display this help message.
  --quiet          -q Do not output any message.
  --verbose        -v|vv|vvv Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
  --version        -V Display this application version.
  --ansi              Force ANSI output.
  --no-ansi           Disable ANSI output.
  --no-interaction -n Do not ask any interactive question.
  --site              Multi-Tiki instance
  --as-user           Run the command as a different user

Available commands:
  help                  Displays help for a command
  list                  Lists commands
backup
  backup:files          Create a backup of Tiki instance files
cache
  cache:clear           Clear Tiki caches
daily-report
  daily-report:send     Send daily user reports
database
  database:backup       Create a database backup (with mysqldump)
  database:configure    Database: Configure (write local.php)
  database:install      Clean Tiki install
  database:redact       Command not available
  database:update       Update the database to the latest schema
goal
  goal:check            Reviews all active goals and assigns rewards.
index
  index:catch-up        Catch-up on incremental indexing.
  index:optimize        Optimize the unified search index
  index:rebuild         Fully rebuild the unified search index
mail-in
  mail-in:poll          Read the mail-in messages
mail-queue
  mail-queue:send       Send the messages stored in the Mail Queue
notification
  notification:digest   Send out email notification digests
profile
  profile:apply         Apply a profile
  profile:baseline      Generate the SQL patch to assign profile symbols for an existing installation.
  profile:export:init   Initialize profile export for current site.
  profile:forget        Forget a profile installation
rss
  rss:refresh           Refresh incoming RSS feeds

user@server:/www/trunk$ php console.php

Console Tool

Usage:
  [options] command [arguments]

Options:
  --help           -h Display this help message.
  --quiet          -q Do not output any message.
  --verbose        -v|vv|vvv Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
  --version        -V Display this application version.
  --ansi              Force ANSI output.
  --no-ansi           Disable ANSI output.
  --no-interaction -n Do not ask any interactive question.
  --site              Multi-Tiki instance

Available commands:
  help                  Displays help for a command
  list                  Lists commands
backup
  backup:files          Create a backup of Tiki instance files
cache
  cache:clear           Clear Tiki caches
daily-report
  daily-report:send     Send daily user reports
database
  database:backup       Create a database backup (with mysqldump)
  database:configure    Database: Configure (write local.php)
  database:install      Clean Tiki install
  database:redact       Command not available
  database:update       Update the database to the latest schema
index
  index:catch-up        Catch-up on incremental indexing.
  index:optimize        Optimize the unified search index
  index:rebuild         Fully rebuild the unified search index
  index:rebuild --log Fully rebuild the unified search index with log output in the console 
mail-queue
  mail-queue:send       Send the messages stored in the Mail Queue
profile
  profile:apply         Apply a profile
  profile:export:init   Initialize profile export for current site.
  profile:forget        Forget a profile installation



Examples

Batch Upload

As of Tiki15 there is a console command for Batch Upload so you can set a scheduled batch upload cron task

Example command line usage
# file according to sub-directory name and create missing galleries
php console.php files:batchupload 1  --subdirToSubgal  --createSubgals

# file according using sub-directory with integer name into gallery with corresponding ID
php console.php files:batchupload 1  --subdirToSubgal --subdirIntegerToSubgalId

# set file user etc so apache can manage the files afterwards
php console.php files:batchupload 1  --fileUser apache --fileGroup allusers --fileMode 0775

# upload files from a different directory
php console.php files:batchupload 1 --filesPath /var/www/other/uploads

# more help
php console.php help files:batchupload

Plugin List Execute

In Tiki16: New actions can be run in conjunction with PluginListExecute:

php console.php list:execute "Page Name" "Action Name"


If you see this type of error message:

[root@server]# php console.php list:execute "Batch Sync Users" "SyncUsersTrackers"
Command not available at this stage. Complete required installation steps.
[root@server]#


You may need to update the database schema first, with the usual:

[root@server]# php console.php d:u

Wiki Plugin Approval

New commands in Tiki18 LTS:
For WikiPlugins
plugin:approve
plugin:list
plugin:refresh

Disable the Installer

Disable the installer:

php console.php installer:lock

Manage files from file galleries

Copy files from a gallery to a regular directory on the filesystem:

php console.php files:copy 1 /tmp/dest/

Move files from a gallery to a regular directory on the filesystem:

php console.php files:move 1 /tmp/dest/ --confirm

Clear Caches and options

All the cache
php console.php c:c
All the cache
php console.php c:c all
Help
php console.php c:c help
Database cache
php console.php c:c private
Modules cache
php console.php c:c modules
Templates cache
php console.php c:c templates
CSS and JS caches
php console.php c:c public

Help on database update

php console.php database:update --help

To mark an upgrade error as registered (so it will be ignored)

php console.php database:update --auto-register

This is useful if you get database errors such as "Duplicate entry..." sometimes

Help on database install

php console.php database:install --help

 Note

If you get Credentials file local.php not found. See http://doc.tiki.org/Installation for more information. message it means you are doing fresh install from command line and need to create the db/local.php file manually first or run the Installer via a web browser.


Getting advanced help

Console-capture-20130429113244-882-0.png

More advanced examples

See more advanced examples, where memory limit or execution timeout are raised, or rebuild is forced and logged, in this other page:

alias

Page last modified on Thursday 24 May, 2018 08:35:32 GMT-0000

doc.tiki.org

Bootstrap AdminGuide UserGuide

Keywords

Keywords serve as "hubs" for navigation within the Tiki documentation. They correspond to development keywords (bug reports and feature requests):

Accessibility (WAI and 508)
Accounting
Articles and Submissions
Backlinks
Banners
Batch
BigBlueButton audio/video/chat/screensharing
Blog
Bookmark
Browser Compatibility
Link Cache
Calendar
Category
Chat
Clean URLs
Comments
Communication Center
Compression (gzip)
Contacts (Address Book)
Contact us
Content Templates
Contribution
Cookie
Copyright
Credit
Custom Home and Group Home Page
Date and Time
Debugger Console
Directory of hyperlinks
Documentation link from Tiki to doc.tiki.org (Help System)
Docs
Draw
Dynamic Content
Dynamic Variable
External Authentication
FAQ
Featured links
File Gallery
Forum
Friendship Network (Community)
Gmap Google maps
Groups
Hotword
HTML Page
i18n (Multilingual, l10n, Babelfish)
Image Gallery
Import-Export
Install
Integrator
Interoperability
Inter-User Messages
InterTiki
Kaltura video management
Karma
Live Support
Login
Logs (system & action)
Look and Feel
Lost edit protection
Mail-in
Map with Mapserver
Menu
Meta Tags
Mobile Tiki and Voice Tiki
Mods
Module
MultiTiki
MyTiki
Newsletter
Notepad
Payment
Performance Speed / Load
Permissions
Platform independence (Linux-Apache, Windows/IIS, Mac, BSD)
Polls
Profiles
Profile Manager
Report
Toolbar
Quiz
Rating
Feeds
Score
Search engine optimization
Search
Search and Replace
Security
Semantic links
Shadowbox
Shadow Layers
Share
Shopping cart
Shoutbox
Slideshow
Smiley
Social Networks
Spam protection (Anti-bot CATPCHA)
Spellcheck
Spreadsheet
Stats
Surveys
Tags
Task
Tell a Friend, alert + Social Bookmarking
TikiTests
Theme CSS & Smarty
Trackers
Transitions
TRIM
User Administration including registration and banning
User Files
User Menu
Watch
WebDAV
Webmail
Web Services
Wiki History, page rename, etc
Wiki Plugin extends basic syntax
Wiki Syntax
Wiki structure (book and table of content)
Workspace
WSOD
WYSIWYCA
WYSIWYG
XMLRPC

Tiki Newsletter

Delivered fresh to your email inbox!
Newsletter subscribe icon
Don't miss major announcements and other news!
Contribute to Tiki
Show php error messages