Difference between revisions of "ARK2/Console"

From ARK
Jump to: navigation, search
(Created page with "= Console = ARK2 uses the Symfony Console to provide three custom command-line consoles for maintaining ARK: * The Build Console - A console to assist in developing ARK and...")
 
(→‎Console)
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
= Console =
 
= Console =
  
−
ARK2 uses the Symfony Console to provide three custom command-line consoles for maintaining ARK:
+
ARK2 uses the [https://symfony.com/doc/current/components/console.html Symfony Console] to provide three custom command-line consoles for maintaining ARK:
  
−
* The Build Console - A console to assist in developing ARK and ARK front-ends
+
* The System Console - A console to assist in managing an ARK system install (./bin/sysadmin)
−
* The System Console - A console to assist in managing an ARK system install
+
* The Site Console - A console to assist in managing an ARK site in a system install (./sites/<site>/bin/console)
−
* The Site Console - A console to assist in managing an ARK site in a system install
+
* The Build Console - A console to assist in developing ARK and ARK front-ends (./build/build)
  
−
Note that separate consoles are required for the System and Site for the multi-site mode of ARK. A combined solution for single-site installs will be developed.
+
The key difference between the System and Site consoles is the System console does not load a specific site configuration when it runs. This allows it to perform maintenance on the whole system or on an individual site even when an individual site configuration is unable to be loaded. The Site Console needs to load a valid site configuration to allow it to perform more advanced site-specific maintenance.
 +
 
 +
The Build Console is for developer use only and is documented under the Frontend Build documentation.
 +
 
 +
== System Console ==
 +
 
 +
The System Console can be run from the command line from the root install folder:
 +
 
 +
./bin/sysadmin
 +
 
 +
Running the console without and parameters displays a help message and the list of available commands:
 +
 
 +
<pre>
 +
ARK System Admin Console 1.9.80
 +
 
 +
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
 +
  -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
 +
cache
 +
  cache:clear          Clear the system cache
 +
database
 +
  database:clone        Clone an existing database
 +
  database:drop:tables  Drop all tables in a database
 +
  database:import      Import an SQL file into a database
 +
  database:server:add  Add a new database server
 +
  database:truncate    Truncate all tables in a database
 +
security
 +
  security:check        Checks security issues in your project dependencies
 +
site
 +
  site:create          Create a new site
 +
  site:frontend        Install or replace a frontend. WARNING: Will delete the old frontend!
 +
  site:migrate:info    Analyse the migration mapping for an ARK 1 site
 +
  site:migrate:load    Migrate an ARK 1.2 site
 +
  site:migrate:map      Create the migration mapping for an ARK 1 site
 +
system
 +
  system:about          Display information about the system
 +
</pre>
 +
 
 +
== Site Console ==
 +
 
 +
The System Console can be run from the command line from the root install folder:
 +
 
 +
./bin/sysadmin
 +
 
 +
Running the console without and parameters displays a help message and the list of available commands:
 +
 
 +
<pre>
 +
ARK Site Admin Console 1.9.80
 +
 
 +
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
 +
  -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
 +
cache
 +
  cache:clear          Clear the system cache
 +
database
 +
  database:drop:tables  Drop all tables in a database
 +
  database:import      Import an SQL file into a database
 +
  database:truncate    Truncate all tables in a database
 +
orm
 +
  orm:entity:generate  Generate ORM Entities for Custom ARK Modules
 +
route
 +
  route:dump            Dump configured route(s)
 +
site
 +
  site:about            Display information about the site
 +
spatial
 +
  spatial:rebuild      Rebuild the Spatial Index
 +
translation
 +
  translation:add      Add or Set a translation.
 +
user
 +
  user:create          Create a new user
 +
  user:delete          Delete a user
 +
  user:disable          Disable a user
 +
  user:enable          Enable a user
 +
  user:list            List all users.
 +
  user:password:reset  Send user a password reset email
 +
  user:password:set    Set the password for a user
 +
  user:role:add        Add a user role
 +
  user:role:delete      Delete a user role
 +
  user:verify          Verify a user's email
 +
view
 +
  view:page:dump        Dump a View Page
 +
</pre>

Latest revision as of 13:01, 17 January 2018

Console

ARK2 uses the Symfony Console to provide three custom command-line consoles for maintaining ARK:

  • The System Console - A console to assist in managing an ARK system install (./bin/sysadmin)
  • The Site Console - A console to assist in managing an ARK site in a system install (./sites/<site>/bin/console)
  • The Build Console - A console to assist in developing ARK and ARK front-ends (./build/build)

The key difference between the System and Site consoles is the System console does not load a specific site configuration when it runs. This allows it to perform maintenance on the whole system or on an individual site even when an individual site configuration is unable to be loaded. The Site Console needs to load a valid site configuration to allow it to perform more advanced site-specific maintenance.

The Build Console is for developer use only and is documented under the Frontend Build documentation.

System Console

The System Console can be run from the command line from the root install folder: 

./bin/sysadmin

Running the console without and parameters displays a help message and the list of available commands: 

ARK System Admin Console 1.9.80

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
  -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
 cache
  cache:clear           Clear the system cache
 database
  database:clone        Clone an existing database
  database:drop:tables  Drop all tables in a database
  database:import       Import an SQL file into a database
  database:server:add   Add a new database server
  database:truncate     Truncate all tables in a database
 security
  security:check        Checks security issues in your project dependencies
 site
  site:create           Create a new site
  site:frontend         Install or replace a frontend. WARNING: Will delete the old frontend!
  site:migrate:info     Analyse the migration mapping for an ARK 1 site
  site:migrate:load     Migrate an ARK 1.2 site
  site:migrate:map      Create the migration mapping for an ARK 1 site
 system
  system:about          Display information about the system

Site Console

The System Console can be run from the command line from the root install folder: 

./bin/sysadmin

Running the console without and parameters displays a help message and the list of available commands: 

ARK Site Admin Console 1.9.80

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
  -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
 cache
  cache:clear           Clear the system cache
 database
  database:drop:tables  Drop all tables in a database
  database:import       Import an SQL file into a database
  database:truncate     Truncate all tables in a database
 orm
  orm:entity:generate   Generate ORM Entities for Custom ARK Modules
 route
  route:dump            Dump configured route(s)
 site
  site:about            Display information about the site
 spatial
  spatial:rebuild       Rebuild the Spatial Index
 translation
  translation:add       Add or Set a translation.
 user
  user:create           Create a new user
  user:delete           Delete a user
  user:disable          Disable a user
  user:enable           Enable a user
  user:list             List all users.
  user:password:reset   Send user a password reset email
  user:password:set     Set the password for a user
  user:role:add         Add a user role
  user:role:delete      Delete a user role
  user:verify           Verify a user's email
 view
  view:page:dump        Dump a View Page
Retrieved from "https://ark.lparchaeology.com/wiki/index.php?title=ARK2/Console&oldid=124861"