acquia / contenthub-console

一个提供Acquia ContentHub命令的CommonConsole命令行界面包。

维护者

详细信息

github.com/acquia/contenthub-console

源代码

问题

安装次数：746,160

依赖项: 0

建议者: 0

安全: 0

星标: 4

关注者: 14

分支: 2

开放问题: 6

类型：项目

1.9 2024-04-18 12:51 UTC

Requires

Requires (Dev)

GPL-2.0-or-later 4b5ebcce92dd152af8fa0692e6a8f757dcaa9b25

This package is auto-updated.

Last update: 2024-09-19 07:49:22 UTC

README

Acquia Cloud Content Hub Console提供了一种命令行工具，可以在属于特定平台的网站上执行Acquia Content Hub相关命令，例如

  • Acquia Cloud
  • Acquia Cloud - 多站点
  • Acquia Site Factory

该工具提供的重要命令之一是允许您通过执行单个命令将网站从Content Hub 1.x升级到2.x，并执行升级所需的所有操作。

安装

使用最新版本的Composer安装此包

$composer require acquia/contenthub-console
$composer install

请注意，此包必须在本地上安装，并在您的远程平台（Acquia Cloud或Acquia Site Factory）的代码库中安装，以便命令可以正常工作。

创建平台

为了使此工具能够远程执行您的Acquia Cloud Platform上的命令，首先使用以下命令创建一个平台

$./vendor/bin/commoncli pc

此命令将引导您完成平台创建过程。请注意，分配给此平台的别名将是在以后远程执行命令时使用的。

用法

以下是一些可用的命令

./vendor/bin/commoncli 
CommonConsole 0.0.1

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
      --uri[=URI]       The url from which to mock a request.
      --bare            Prevents output styling.
  -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
 ace
  ace:cron:check                     [ace-cch] Checks for Scheduled Jobs which are running Content Hub queues.
  ace:cron:create                    [ace-cc] Creates Scheduled Jobs for Acquia Content Hub Export/Import queues.
  ace:cron:list                      [ace-cl] Lists Scheduled Jobs.
  ace:database:backup:create         [ace-dbcr] Creates database backups.
  ace:database:backup:delete         [ace-dbdel] Deletes database backups.
  ace:database:backup:list           [ace-dbl] Lists database backups.
  ace:database:backup:restore        [ace-dbres] Restores database backups.
 ace-multi
  ace-multi:cron:create              [ace-ccm] Create cron jobs for queues in multi-site environment.
  ace-multi:database:backup:create   [ace-dbcrm] Creates database backups for ACE Multi-site environments.
  ace-multi:database:backup:delete   [ace-dbdelm] Deletes database backups for ACE Multi-site environments.
  ace-multi:database:backup:list     [ace-dblm] Lists database backups for ACE Multi-site environments.
  ace-multi:database:backup:restore  [ace-dbresm] Restores database backups for ACE Multisite environments.
 ach
  ach:audit:config-uuid              [audit-uuid] Audits configuration entities for empty UUIDs.
  ach:audit:full                     [ach-audit] Audits an existing site and code base to determine if there are any Content Hub level concerns.
  ach:audit:publisher-queue          [ach-apq] Checks whether the publisher queue is empty and there are no queued entities in the publisher tracking table.
  ach:audit:settings                 [ach-as] Audits Content Hub settings for differences between database settings and overridden ones.
  ach:clients                        [ach-cl] Lists the clients registered in the Acquia Content Hub Subscription.
  ach:custom-fields                  [ach-cf] Checks if custom field type implementations are supported by Content Hub.
  ach:drush                          [drush] A wrapper for running Drush commands.
  ach:health-check:interest-diff     [ach-hc-id] Lists the differences between webhook's interest list and export/import tracking tables.
  ach:health-check:webhook-status    [ach-hc-ws] Prints status of Webhooks and if they are suppressed.
  ach:layout-builder-defaults        [ach-lbd] Checks Layout Builder defaults usage.
  ach:migrate:purge-delwh            [ach-pdw] Purges Content Hub Subscription and deletes Webhooks.
  ach:module:version                 [ach-mv] Checks if platform sites have the Content Hub module 2.x version.
  ach:panelizer-check                [ach-pan] Checks use of Panelizer module.
  ach:subscription                   [ach-sub] Sets up the credentials for a Content Hub Subscription.
  ach:upgrade:start                  [ach-ustart] Starts the Upgrade Process from Acquia Content Hub 1.x to 2.x.
  ach:verify-current-site-webhook    [ach-vcsw] Verify if this site's webhook as defined in the configuration is actually registered in the Content Hub service.
  ach:webhook:status                 [ach-ws] Uses the Content Hub Service to collect information about the status of webhooks.
 acsf
  acsf:cron:check                    [acsf-cch] Checks for Scheduled Jobs which are running Content Hub queues.
  acsf:cron:create                   [acsf-cc] Creates Scheduled Jobs for Acquia Content Hub Export/Import queues.
  acsf:cron:list                     [acsf-cl] List Scheduled Jobs
  acsf:database:backup:create        [acsf-dbc] Creates database backups for each site on the ACSF platform.
  acsf:database:backup:delete        [acsf-dbd] Deletes a database backup of a site in the ACSF platform.
  acsf:database:backup:list          [acsf-dbl] List database backups for ACSF sites.
  acsf:database:backup:restore       [acsf-dbr] Restores database backups for ACSF sites.
 backup
  backup:create                      [bc] Creates a backup bundle of Acquia Content Hub Service snapshot and database site backups.
  backup:delete                      [bd] Deletes a backup bundle of Acquia Content Hub Service snapshot and database site backups.
  backup:list                        [bl] List available backup bundles of Content Hub Service snapshots and database site backups.
  backup:restore                     [br] Restores a backup bundle of Acquia Content Hub Service snapshot and database site backups.
 drush
  drush:version                      Checks drush version on the server.
 platform
  platform:create                    [pc] Create a new platform on which to execute common console commands.
  platform:delete                    [pdel] Deletes the specified platform.
  platform:describe                  [pd] Obtain more details about a platform.
  platform:list                      [pl] List available platforms.
  platform:sites                     List available sites registered in the platform.

以下命令允许您将平台“sample-platform”上的网站从Content Hub 1.x升级到2.x

$./vendor/bin/commoncli ach:upgrade:start @sample-platform

其中平台“sample-platform”已创建。

文档

可以使用phpDocumentor v3生成API文档。
最快、最简单的方式生成无污染的文档

docker run -it --rm -v $(pwd):/data phpdoc/phpdoc:3 -t docs/api -d .

版权和许可证

版权 © 2021 Acquia Inc.

本程序是自由软件；您可以按照自由软件基金会发布的GNU通用公共许可证的条款重新分发和/或修改它；许可证的第2版，或（根据您的选择）任何后续版本。

本程序是根据希望它将是有用的，但没有任何保证；甚至没有适销性或特定用途的隐含保证。有关详细信息，请参阅GNU通用公共许可证。

您应已收到GNU通用公共许可证副本；如果没有，请写信给自由软件基金会，Inc.，51 Franklin Street，第五层，波士顿，MA 02110-1301 USA。