# jahia-cli > Command Line Interface to Jahia Administration panel Latest version **0.0.70** (published 2021-12-16) · MIT license · 0 weekly downloads ## Install ```sh npm install jahia-cli pnpm add jahia-cli yarn add jahia-cli bun add jahia-cli ``` Provides the command `jahia-cli`. ## Health **Score 25/100 (F)** — status: abandoned. Positive: has types; no vulnerabilities; high quality score. Warnings: low downloads; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.0.70 | | Published | 2021-12-16 | | First published | 2020-01-23 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | CommonJS | | Node | >=12.14.1 | | Dependencies | 36 | | Unpacked size | 202.3 KB | | Known vulnerabilities | 0 (+33 in 4 direct dependencies) | | Install scripts | no | | Author | Francois Gerthoffert @Fgerthoffert | | Maintainers | fgerthoffert | | Keywords | oclif | ## Links - npm: https://www.npmjs.com/package/jahia-cli - Repository: https://github.com/jahia/jahia-cli - Homepage: https://github.com/fgerthoffert/jahia-cli - Issues: https://github.com/fgerthoffert/jahia-cli/issues - npm.io page: https://npm.io/package/jahia-cli ## Dependencies (36) - [gql](https://npm.io/package/gql.md) ^1.1.2 - [btoa](https://npm.io/package/btoa.md) ^1.2.1 - [uuid](https://npm.io/package/uuid.md) ^8.3.1 - [axios](https://npm.io/package/axios.md) ^0.21.1 - [maven](https://npm.io/package/maven.md) ^4.7.0 - [tslib](https://npm.io/package/tslib.md) ^1 - [cli-ux](https://npm.io/package/cli-ux.md) ^5.4.2 - [semver](https://npm.io/package/semver.md) ^7.3.5 - [xml2js](https://npm.io/package/xml2js.md) ^0.4.23 - [base-64](https://npm.io/package/base-64.md) ^0.1.0 - [graphql](https://npm.io/package/graphql.md) ^14.5.8 - [js-yaml](https://npm.io/package/js-yaml.md) ^3.13.1 - [form-data](https://npm.io/package/form-data.md) ^3.0.0 - [js-base64](https://npm.io/package/js-base64.md) ^3.6.0 - [puppeteer](https://npm.io/package/puppeteer.md) ^5.2.1 - [node-fetch](https://npm.io/package/node-fetch.md) ^2.6.0 - [simple-git](https://npm.io/package/simple-git.md) ^1.131.0 - [@types/btoa](https://npm.io/package/@types/btoa.md) ^1.2.3 - [@types/uuid](https://npm.io/package/@types/uuid.md) ^8.3.0 - [apollo-link](https://npm.io/package/apollo-link.md) ^1.2.13 - [graphql-tag](https://npm.io/package/graphql-tag.md) ^2.10.1 - [object-hash](https://npm.io/package/object-hash.md) ^2.0.1 - [@oclif/config](https://npm.io/package/@oclif/config.md) ^1 - [@types/cookie](https://npm.io/package/@types/cookie.md) ^0.3.3 - [apollo-client](https://npm.io/package/apollo-client.md) ^2.6.8 - [@oclif/command](https://npm.io/package/@oclif/command.md) ^1 - [@types/base-64](https://npm.io/package/@types/base-64.md) ^0.1.3 - [@types/js-yaml](https://npm.io/package/@types/js-yaml.md) ^3.12.1 - [load-yaml-file](https://npm.io/package/load-yaml-file.md) ^0.2.0 - [@types/puppeteer](https://npm.io/package/@types/puppeteer.md) ^2.0.0 - [apollo-link-http](https://npm.io/package/apollo-link-http.md) ^1.5.16 - [@types/node-fetch](https://npm.io/package/@types/node-fetch.md) ^2.5.4 - [apollo-link-error](https://npm.io/package/apollo-link-error.md) ^1.1.12 - [@oclif/plugin-help](https://npm.io/package/@oclif/plugin-help.md) ^2 - [@types/object-hash](https://npm.io/package/@types/object-hash.md) ^1.3.1 - [apollo-cache-inmemory](https://npm.io/package/apollo-cache-inmemory.md) ^1.6.5 ## Alternatives - [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads - [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads - [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads - [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads - [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads ## Recent versions - 0.0.70 (latest) — 2021-12-16 - 0.0.69 — 2021-12-16 - 0.0.63 — 2021-07-05 - 0.0.62 — 2021-07-05 - 0.0.61 — 2021-06-25 - 0.0.60 — 2021-03-31 - 0.0.59 — 2021-03-31 - 0.0.58 — 2021-03-31 - 0.0.57 — 2021-03-31 - 0.0.56 — 2021-03-31 - 0.0.55 — 2021-03-31 - 0.0.54 — 2021-03-31 - 0.0.53 — 2021-03-26 - 0.0.52 — 2021-03-26 - 0.0.51 — 2021-03-24 - … 43 more at https://npm.io/package/jahia-cli/versions ## README ``` /!\ POC, NOT READY, DO NOT USE /!\ /!\ POC, NOT READY, DO NOT USE /!\ /!\ POC, NOT READY, DO NOT USE /!\ /!\ POC, NOT READY, DO NOT USE /!\ /!\ POC, NOT READY, DO NOT USE /!\ /!\ POC, NOT READY, DO NOT USE /!\ ``` # jahia-cli Command Line Interface to Jahia Administration panel [![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io) [![Version](https://img.shields.io/npm/v/jahia-cli.svg)](https://npmjs.org/package/jahia-cli) [![Downloads/week](https://img.shields.io/npm/dw/jahia-cli.svg)](https://npmjs.org/package/jahia-cli) [![License](https://img.shields.io/npm/l/jahia-cli.svg)](https://github.com/jahia/jahia-cli/blob/master/package.json) _This readme is being updated automatically during NPM publish, please look at the [NPM Page](https://www.npmjs.com/package/jahia-cli) for a full list of available commands._ * [jahia-cli](#jahia-cli) * [Introduction](#introduction) * [Manifest](#manifest) * [Usage](#usage) * [Commands](#commands) # Introduction This tool provides an interface to automate the execution of certain tasks on a running Jahia instance. It can execute individual commands or receive a manifest detailing a list of commands to be executed in batch (sequentially). It covers the following primary use cases: - Operations on modules (build from Git, install, enable, disable) - Operations on web projects (check status, import, install) - Download an asset - Execution of groovy scripts - Execution of shell commands - Wait for Jahia to be alive - Misc utilities (docker, search, ...) # Manifest The primary objective of the manifest is to be able to declare, in a dedicated YML file, a set of actions to be executed sequentially, for example: - Wait for Jahia to be up and runnning - Download a module - Install the module - Configure it with Groovy - Install a site - Enable the module on the installed site You can generate a blank manifest by running the command `jahia-cli manifest:create` # Usage ```sh-session $ npm install -g jahia-cli $ jahia-cli COMMAND running command... $ jahia-cli (-v|--version|version) jahia-cli/0.0.70 linux-x64 node-v17.1.0 $ jahia-cli --help [COMMAND] USAGE $ jahia-cli COMMAND ... ``` # Commands * [`jahia-cli alive [FILE]`](#jahia-cli-alive-file) * [`jahia-cli assets:load [FILE]`](#jahia-cli-assetsload-file) * [`jahia-cli docker:getimgname [FILE]`](#jahia-cli-dockergetimgname-file) * [`jahia-cli groovy:execute [FILE]`](#jahia-cli-groovyexecute-file) * [`jahia-cli help [COMMAND]`](#jahia-cli-help-command) * [`jahia-cli manifest:create [FILE]`](#jahia-cli-manifestcreate-file) * [`jahia-cli manifest:id [FILE]`](#jahia-cli-manifestid-file) * [`jahia-cli manifest:run [FILE]`](#jahia-cli-manifestrun-file) * [`jahia-cli modules:build [FILE]`](#jahia-cli-modulesbuild-file) * [`jahia-cli modules:check [FILE]`](#jahia-cli-modulescheck-file) * [`jahia-cli modules:disable [FILE]`](#jahia-cli-modulesdisable-file) * [`jahia-cli modules:enable [FILE]`](#jahia-cli-modulesenable-file) * [`jahia-cli modules:install [FILE]`](#jahia-cli-modulesinstall-file) * [`jahia-cli search:check [FILE]`](#jahia-cli-searchcheck-file) * [`jahia-cli search:startindex [FILE]`](#jahia-cli-searchstartindex-file) * [`jahia-cli shell:run [FILE]`](#jahia-cli-shellrun-file) * [`jahia-cli webprojects:available [FILE]`](#jahia-cli-webprojectsavailable-file) * [`jahia-cli webprojects:import [FILE]`](#jahia-cli-webprojectsimport-file) * [`jahia-cli webprojects:installed [FILE]`](#jahia-cli-webprojectsinstalled-file) ## `jahia-cli alive [FILE]` Indefinitely wait until a Jahia instance becomes available ``` Indefinitely wait until a Jahia instance becomes available USAGE $ jahia-cli alive [FILE] OPTIONS -d, --debug Enable debug mode (display chrome browser) -h, --help show CLI help -s, --nosandbox Uses the --no-sandbox flag for performing actions requiring chromium -t, --timeout=timeout Specify a timeout after which the process will exit with an error --dockerRegistryPassword=dockerRegistryPassword (required) [default: password] Docker registry (i.e. docker hub) password --dockerRegistryUsername=dockerRegistryUsername (required) [default: username] Docker registry (i.e. docker hub) username --jahiaAdminPassword=jahiaAdminPassword (required) [default: root] Jahia Administrator interface Password --jahiaAdminUrl=jahiaAdminUrl (required) [default: http://localhost:8080] Jahia Administrator interface URL --jahiaAdminUsername=jahiaAdminUsername (required) [default: root] Jahia Administrator interface Username --jahiaToolsPassword=jahiaToolsPassword (required) [default: password] Jahia Tools Password --jahiaToolsUsername=jahiaToolsUsername (required) [default: jahia] Jahia Tools (modules/tools) Username --output=output Output values to the filesystem (such as payload) ``` _See code: [src/commands/alive.ts](https://github.com/jahia/jahia-cli/blob/v0.0.70/src/commands/alive.ts)_ ## `jahia-cli assets:load [FILE]` Download assets from a manifest to the local filesystem ``` Download assets from a manifest to the local filesystem USAGE $ jahia-cli assets:load [FILE] OPTIONS -d, --debug Enable debug mode (display chrome browser) -h, --help show CLI help -s, --nosandbox Uses the --no-sandbox flag for performing actions requiring chromium --dockerRegistryPassword=dockerRegistryPassword (required) [default: password] Docker registry (i.e. docker hub) password --dockerRegistryUsername=dockerRegistryUsername (required) [default: username] Docker registry (i.e. docker hub) username --jahiaAdminPassword=jahiaAdminPassword (required) [default: root] Jahia Administrator interface Password --jahiaAdminUrl=jahiaAdminUrl (required) [default: http://localhost:8080] Jahia Administrator interface URL --jahiaAdminUsername=jahiaAdminUsername (required) [default: root] Jahia Administrator interface Username --jahiaToolsPassword=jahiaToolsPassword (required) [default: password] Jahia Tools Password --jahiaToolsUsername=jahiaToolsUsername (required) [default: jahia] Jahia Tools (modules/tools) Username --manifest=manifest (required) Specify the filepath to the manifest --output=output Output values to the filesystem (such as payload) --password=password Password for basic auth --username=username Username for basic auth ``` _See code: [src/commands/assets/load.ts](https://github.com/jahia/jahia-cli/blob/v0.0.70/src/commands/assets/load.ts)_ ## `jahia-cli docker:getimgname [FILE]` Returns the docker image name to be used based on manifest content and hash ``` Returns the docker image name to be used based on manifest content and hash USAGE $ jahia-cli docker:getimgname [FILE] OPTIONS -b, --build Forces build of new images -d, --debug Enable debug mode (display chrome browser) -h, --help show CLI help -s, --nosandbox Uses the --no-sandbox flag for performing actions requiring chromium --dockerRegistryPassword=dockerRegistryPassword (required) [default: password] Docker registry (i.e. docker hub) password --dockerRegistryUsername=dockerRegistryUsername (required) [default: username] Docker registry (i.e. docker hub) username --jahiaAdminPassword=jahiaAdminPassword (required) [default: root] Jahia Administrator interface Password --jahiaAdminUrl=jahiaAdminUrl (required) [default: http://localhost:8080] Jahia Administrator interface URL --jahiaAdminUsername=jahiaAdminUsername (required) [default: root] Jahia Administrator interface Username --jahiaToolsPassword=jahiaToolsPassword (required) [default: password] Jahia Tools Password --jahiaToolsUsername=jahiaToolsUsername (required) [default: jahia] Jahia Tools (modules/tools) Username --manifest=manifest (required) Specify the directory to generate the manifest file into --output=output Output values to the filesystem (such as payload) ``` _See code: [src/commands/docker/getimgname.ts](https://github.com/jahia/jahia-cli/blob/v0.0.70/src/commands/docker/getimgname.ts)_ ## `jahia-cli groovy:execute [FILE]` Executes a groovy script by providing its filename ``` Executes a groovy script by providing its filename USAGE $ jahia-cli groovy:execute [FILE] OPTIONS -d, --debug Enable debug mode (display chrome browser) -h, --help show CLI help -s, --nosandbox Uses the --no-sandbox flag for performing actions requiring chromium --dockerRegistryPassword=dockerRegistryPassword (required) [default: password] Docker registry (i.e. docker hub) password --dockerRegistryUsername=dockerRegistryUsername (required) [default: username] Docker registry (i.e. docker hub) username --file=file (required) Specify the filepath to the module to be installed (jar on filesystem) --jahiaAdminPassword=jahiaAdminPassword (required) [default: root] Jahia Administrator interface Password --jahiaAdminUrl=jahiaAdminUrl (required) [default: http://localhost:8080] Jahia Administrator interface URL --jahiaAdminUsername=jahiaAdminUsername (required) [default: root] Jahia Administrator interface Username --jahiaToolsPassword=jahiaToolsPassword (required) [default: password] Jahia Tools Password --jahiaToolsUsername=jahiaToolsUsername (required) [default: jahia] Jahia Tools (modules/tools) Username --output=output Output values to the filesystem (such as payload) --version=version Specify the module version to be installed ``` _See code: [src/commands/groovy/execute.ts](https://github.com/jahia/jahia-cli/blob/v0.0.70/src/commands/groovy/execute.ts)_ ## `jahia-cli help [COMMAND]` display help for jahia-cli ``` display help for <%= config.bin %> USAGE $ jahia-cli help [COMMAND] ARGUMENTS COMMAND command to show help for OPTIONS --all see all commands in CLI ``` _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v2.2.3/src/commands/help.ts)_ ## `jahia-cli manifest:create [FILE]` Creates an empty manifest file ``` Creates an empty manifest file USAGE $ jahia-cli manifest:create [FILE] OPTIONS -d, --debug Enable debug mode (display chrome browser) -h, --help show CLI help -s, --nosandbox Uses the --no-sandbox flag for performing actions requiring chromium --dockerRegistryPassword=dockerRegistryPassword (required) [default: password] Docker registry (i.e. docker hub) password --dockerRegistryUsername=dockerRegistryUsername (required) [default: username] Docker registry (i.e. docker hub) username --jahiaAdminPassword=jahiaAdminPassword (required) [default: root] Jahia Administrator interface Password --jahiaAdminUrl=jahiaAdminUrl (required) [default: http://localhost:8080] Jahia Administrator interface URL --jahiaAdminUsername=jahiaAdminUsername (required) [default: root] Jahia Administrator interface Username --jahiaToolsPassword=jahiaToolsPassword (required) [default: password] Jahia Tools Password --jahiaToolsUsername=jahiaToolsUsername (required) [default: jahia] Jahia Tools (modules/tools) Username --manifest=manifest (required) Specify the directory to generate the manifest file into --output=output Output values to the filesystem (such as payload) ``` _See code: [src/commands/manifest/create.ts](https://github.com/jahia/jahia-cli/blob/v0.0.70/src/commands/manifest/create.ts)_ ## `jahia-cli manifest:id [FILE]` Generates a unique ID from a manifest content ``` Generates a unique ID from a manifest content USAGE $ jahia-cli manifest:id [FILE] OPTIONS -d, --debug Enable debug mode (display chrome browser) -h, --help show CLI help -s, --nosandbox Uses the --no-sandbox flag for performing actions requiring chromium --dockerRegistryPassword=dockerRegistryPassword (required) [default: password] Docker registry (i.e. docker hub) password --dockerRegistryUsername=dockerRegistryUsername (required) [default: username] Docker registry (i.e. docker hub) username --jahiaAdminPassword=jahiaAdminPassword (required) [default: root] Jahia Administrator interface Password --jahiaAdminUrl=jahiaAdminUrl (required) [default: http://localhost:8080] Jahia Administrator interface URL --jahiaAdminUsername=jahiaAdminUsername (required) [default: root] Jahia Administrator interface Username --jahiaToolsPassword=jahiaToolsPassword (required) [default: password] Jahia Tools Password --jahiaToolsUsername=jahiaToolsUsername (required) [default: jahia] Jahia Tools (modules/tools) Username --manifest=manifest (required) Specify the directory to generate the manifest file into --output=output Output values to the filesystem (such as payload) ``` _See code: [src/commands/manifest/id.ts](https://github.com/jahia/jahia-cli/blob/v0.0.70/src/commands/manifest/id.ts)_ ## `jahia-cli manifest:run [FILE]` Install modules from a manifest file ``` Install modules from a manifest file USAGE $ jahia-cli manifest:run [FILE] OPTIONS -d, --debug Enable debug mode (display chrome browser) -h, --help show CLI help -s, --nosandbox Uses the --no-sandbox flag for performing actions requiring chromium --dockerRegistryPassword=dockerRegistryPassword (required) [default: password] Docker registry (i.e. docker hub) password --dockerRegistryUsername=dockerRegistryUsername (required) [default: username] Docker registry (i.e. docker hub) username --jahiaAdminPassword=jahiaAdminPassword (required) [default: root] Jahia Administrator interface Password --jahiaAdminUrl=jahiaAdminUrl (required) [default: http://localhost:8080] Jahia Administrator interface URL --jahiaAdminUsername=jahiaAdminUsername (required) [default: root] Jahia Administrator interface Username --jahiaToolsPassword=jahiaToolsPassword (required) [default: password] Jahia Tools Password --jahiaToolsUsername=jahiaToolsUsername (required) [default: jahia] Jahia Tools (modules/tools) Username --manifest=manifest (required) Specify the filepath to the manifest --output=output Output values to the filesystem (such as payload) ``` _See code: [src/commands/manifest/run.ts](https://github.com/jahia/jahia-cli/blob/v0.0.70/src/commands/manifest/run.ts)_ ## `jahia-cli modules:build [FILE]` Installs a module ``` Installs a module USAGE $ jahia-cli modules:build [FILE] OPTIONS -d, --debug Enable debug mode (display chrome browser) -h, --help show CLI help -s, --nosandbox Uses the --no-sandbox flag for performing actions requiring chromium --branch=branch (required) [default: master] Git repository branch --deploy=deploy [default: true] Trigger a deployment of the module --directory=directory (required) Directory to use as a base for storing the build artifacts --dockerRegistryPassword=dockerRegistryPassword (required) [default: password] Docker registry (i.e. docker hub) password --dockerRegistryUsername=dockerRegistryUsername (required) [default: username] Docker registry (i.e. docker hub) username --file=file Specify the filepath to the module to be installed (jar on filesystem) --gitpath=gitpath (required) Path to the pom if not at the repository root --id=id (required) [default: ldap] Module Id --jahiaAdminPassword=jahiaAdminPassword (required) [default: root] Jahia Administrator interface Password --jahiaAdminUrl=jahiaAdminUrl (required) [default: http://localhost:8080] Jahia Administrator interface URL --jahiaAdminUsername=jahiaAdminUsername (required) [default: root] Jahia Administrator interface Username --jahiaToolsPassword=jahiaToolsPassword (required) [default: password] Jahia Tools Password --jahiaToolsUsername=jahiaToolsUsername (required) [default: jahia] Jahia Tools (modules/tools) Username --output=output Output values to the filesystem (such as payload) --repository=repository (required) [default: git@github.com:Jahia/LDAP-provider.git] Repository to clone ``` _See code: [src/commands/modules/build.ts](https://github.com/jahia/jahia-cli/blob/v0.0.70/src/commands/modules/build.ts)_ ## `jahia-cli modules:check [FILE]` Check if a module is installed by providing its id ``` Check if a module is installed by providing its id USAGE $ jahia-cli modules:check [FILE] OPTIONS -d, --debug Enable debug mode (display chrome browser) -h, --help show CLI help -s, --nosandbox Uses the --no-sandbox flag for performing actions requiring chromium --dockerRegistryPassword=dockerRegistryPassword (required) [default: password] Docker registry (i.e. docker hub) password --dockerRegistryUsername=dockerRegistryUsername (required) [default: username] Docker registry (i.e. docker hub) username --id=id Module Id --jahiaAdminPassword=jahiaAdminPassword (required) [default: root] Jahia Administrator interface Password --jahiaAdminUrl=jahiaAdminUrl (required) [default: http://localhost:8080] Jahia Administrator interface URL --jahiaAdminUsername=jahiaAdminUsername (required) [default: root] Jahia Administrator interface Username --jahiaToolsPassword=jahiaToolsPassword (required) [default: password] Jahia Tools Password --jahiaToolsUsername=jahiaToolsUsername (required) [default: jahia] Jahia Tools (modules/tools) Username --output=output Output values to the filesystem (such as payload) ``` _See code: [src/commands/modules/check.ts](https://github.com/jahia/jahia-cli/blob/v0.0.70/src/commands/modules/check.ts)_ ## `jahia-cli modules:disable [FILE]` Disable a module on a particular site ``` Disable a module on a particular site USAGE $ jahia-cli modules:disable [FILE] OPTIONS -d, --debug Enable debug mode (display chrome browser) -h, --help show CLI help -s, --nosandbox Uses the --no-sandbox flag for performing actions requiring chromium --dockerRegistryPassword=dockerRegistryPassword (required) [default: password] Docker registry (i.e. docker hub) password --dockerRegistryUsername=dockerRegistryUsername (required) [default: username] Docker registry (i.e. docker hub) username --jahiaAdminPassword=jahiaAdminPassword (required) [default: root] Jahia Administrator interface Password --jahiaAdminUrl=jahiaAdminUrl (required) [default: http://localhost:8080] Jahia Administrator interface URL --jahiaAdminUsername=jahiaAdminUsername (required) [default: root] Jahia Administrator interface Username --jahiaToolsPassword=jahiaToolsPassword (required) [default: password] Jahia Tools Password --jahiaToolsUsername=jahiaToolsUsername (required) [default: jahia] Jahia Tools (modules/tools) Username --mid=mid (required) Module ID (for example: augmented-search-ui) --output=output Output values to the filesystem (such as payload) --sid=sid (required) Site ID (for example: digitall) ``` _See code: [src/commands/modules/disable.ts](https://github.com/jahia/jahia-cli/blob/v0.0.70/src/commands/modules/disable.ts)_ ## `jahia-cli modules:enable [FILE]` Enable a module on a particular site ``` Enable a module on a particular site USAGE $ jahia-cli modules:enable [FILE] OPTIONS -d, --debug Enable debug mode (display chrome browser) -h, --help show CLI help -s, --nosandbox Uses the --no-sandbox flag for performing actions requiring chromium --dockerRegistryPassword=dockerRegistryPassword (required) [default: password] Docker registry (i.e. docker hub) password --dockerRegistryUsername=dockerRegistryUsername (required) [default: username] Docker registry (i.e. docker hub) username --jahiaAdminPassword=jahiaAdminPassword (required) [default: root] Jahia Administrator interface Password --jahiaAdminUrl=jahiaAdminUrl (required) [default: http://localhost:8080] Jahia Administrator interface URL --jahiaAdminUsername=jahiaAdminUsername (required) [default: root] Jahia Administrator interface Username --jahiaToolsPassword=jahiaToolsPassword (required) [default: password] Jahia Tools Password --jahiaToolsUsername=jahiaToolsUsername (required) [default: jahia] Jahia Tools (modules/tools) Username --mid=mid (required) Module ID (for example: augmented-search-ui) --output=output Output values to the filesystem (such as payload) --sid=sid (required) Site ID (for example: digitall) ``` _See code: [src/commands/modules/enable.ts](https://github.com/jahia/jahia-cli/blob/v0.0.70/src/commands/modules/enable.ts)_ ## `jahia-cli modules:install [FILE]` Installs a module ``` Installs a module USAGE $ jahia-cli modules:install [FILE] OPTIONS -d, --debug Enable debug mode (display chrome browser) -h, --help show CLI help -s, --nosandbox Uses the --no-sandbox flag for performing actions requiring chromium --dockerRegistryPassword=dockerRegistryPassword (required) [default: password] Docker registry (i.e. docker hub) password --dockerRegistryUsername=dockerRegistryUsername (required) [default: username] Docker registry (i.e. docker hub) username --file=file (required) Specify the filepath to the module to be installed (jar on filesystem) --force Forces modules installation (even if already installed) --id=id (required) Module Id --jahiaAdminPassword=jahiaAdminPassword (required) [default: root] Jahia Administrator interface Password --jahiaAdminUrl=jahiaAdminUrl (required) [default: http://localhost:8080] Jahia Administrator interface URL --jahiaAdminUsername=jahiaAdminUsername (required) [default: root] Jahia Administrator interface Username --jahiaToolsPassword=jahiaToolsPassword (required) [default: password] Jahia Tools Password --jahiaToolsUsername=jahiaToolsUsername (required) [default: jahia] Jahia Tools (modules/tools) Username --output=output Output values to the filesystem (such as payload) --version=version Specify the module version to be installed ``` _See code: [src/commands/modules/install.ts](https://github.com/jahia/jahia-cli/blob/v0.0.70/src/commands/modules/install.ts)_ ## `jahia-cli search:check [FILE]` Runs a graphql query against search and wait until there is a set number of hits ``` Runs a graphql query against search and wait until there is a set number of hits USAGE $ jahia-cli search:check [FILE] OPTIONS -d, --debug Enable debug mode (display chrome browser) -h, --help show CLI help -s, --nosandbox Uses the --no-sandbox flag for performing actions requiring chromium -t, --timeout=timeout Specify a timeout after which the process will exit with an error --dockerRegistryPassword=dockerRegistryPassword (required) [default: password] Docker registry (i.e. docker hub) password --dockerRegistryUsername=dockerRegistryUsername (required) [default: username] Docker registry (i.e. docker hub) username --hits=hits [default: 10] Speficy the minimum number of hits --jahiaAdminPassword=jahiaAdminPassword (required) [default: root] Jahia Administrator interface Password --jahiaAdminUrl=jahiaAdminUrl (required) [default: http://localhost:8080] Jahia Administrator interface URL --jahiaAdminUsername=jahiaAdminUsername (required) [default: root] Jahia Administrator interface Username --jahiaToolsPassword=jahiaToolsPassword (required) [default: password] Jahia Tools Password --jahiaToolsUsername=jahiaToolsUsername (required) [default: jahia] Jahia Tools (modules/tools) Username --nodetype=nodetype [default: mix:title] Speficy the nodetype to search (ex: mix:title) --output=output Output values to the filesystem (such as payload) --query=query [default: a] Speficy the query string --sitekey=sitekey [default: digitall] Speficy the site to test towards ``` _See code: [src/commands/search/check.ts](https://github.com/jahia/jahia-cli/blob/v0.0.70/src/commands/search/check.ts)_ ## `jahia-cli search:startindex [FILE]` Trigger the indexing job once the site has been imported ``` Trigger the indexing job once the site has been imported USAGE $ jahia-cli search:startindex [FILE] OPTIONS -d, --debug Enable debug mode (display chrome browser) -h, --help show CLI help -s, --nosandbox Uses the --no-sandbox flag for performing actions requiring chromium --dockerRegistryPassword=dockerRegistryPassword (required) [default: password] Docker registry (i.e. docker hub) password --dockerRegistryUsername=dockerRegistryUsername (required) [default: username] Docker registry (i.e. docker hub) username --jahiaAdminPassword=jahiaAdminPassword (required) [default: root] Jahia Administrator interface Password --jahiaAdminUrl=jahiaAdminUrl (required) [default: http://localhost:8080] Jahia Administrator interface URL --jahiaAdminUsername=jahiaAdminUsername (required) [default: root] Jahia Administrator interface Username --jahiaToolsPassword=jahiaToolsPassword (required) [default: password] Jahia Tools Password --jahiaToolsUsername=jahiaToolsUsername (required) [default: jahia] Jahia Tools (modules/tools) Username --output=output Output values to the filesystem (such as payload) ``` _See code: [src/commands/search/startindex.ts](https://github.com/jahia/jahia-cli/blob/v0.0.70/src/commands/search/startindex.ts)_ ## `jahia-cli shell:run [FILE]` Run a shell command ``` Run a shell command USAGE $ jahia-cli shell:run [FILE] OPTIONS -d, --debug Enable debug mode (display chrome browser) -h, --help show CLI help -s, --nosandbox Uses the --no-sandbox flag for performing actions requiring chromium --cmd=cmd (required) Shell command to be executed --dockerRegistryPassword=dockerRegistryPassword (required) [default: password] Docker registry (i.e. docker hub) password --dockerRegistryUsername=dockerRegistryUsername (required) [default: username] Docker registry (i.e. docker hub) username --jahiaAdminPassword=jahiaAdminPassword (required) [default: root] Jahia Administrator interface Password --jahiaAdminUrl=jahiaAdminUrl (required) [default: http://localhost:8080] Jahia Administrator interface URL --jahiaAdminUsername=jahiaAdminUsername (required) [default: root] Jahia Administrator interface Username --jahiaToolsPassword=jahiaToolsPassword (required) [default: password] Jahia Tools Password --jahiaToolsUsername=jahiaToolsUsername (required) [default: jahia] Jahia Tools (modules/tools) Username --output=output Output values to the filesystem (such as payload) ``` _See code: [src/commands/shell/run.ts](https://github.com/jahia/jahia-cli/blob/v0.0.70/src/commands/shell/run.ts)_ ## `jahia-cli webprojects:available [FILE]` List available prepackaged projects ``` List available prepackaged projects USAGE $ jahia-cli webprojects:available [FILE] OPTIONS -d, --debug Enable debug mode (display chrome browser) -h, --help show CLI help -s, --nosandbox Uses the --no-sandbox flag for performing actions requiring chromium --dockerRegistryPassword=dockerRegistryPassword (required) [default: password] Docker registry (i.e. docker hub) password --dockerRegistryUsername=dockerRegistryUsername (required) [default: username] Docker registry (i.e. docker hub) username --jahiaAdminPassword=jahiaAdminPassword (required) [default: root] Jahia Administrator interface Password --jahiaAdminUrl=jahiaAdminUrl (required) [default: http://localhost:8080] Jahia Administrator interface URL --jahiaAdminUsername=jahiaAdminUsername (required) [default: root] Jahia Administrator interface Username --jahiaToolsPassword=jahiaToolsPassword (required) [default: password] Jahia Tools Password --jahiaToolsUsername=jahiaToolsUsername (required) [default: jahia] Jahia Tools (modules/tools) Username --output=output Output values to the filesystem (such as payload) ``` _See code: [src/commands/webprojects/available.ts](https://github.com/jahia/jahia-cli/blob/v0.0.70/src/commands/webprojects/available.ts)_ ## `jahia-cli webprojects:import [FILE]` Create a site by importing a prepackaged project ``` Create a site by importing a prepackaged project USAGE $ jahia-cli webprojects:import [FILE] OPTIONS -d, --debug Enable debug mode (display chrome browser) -h, --help show CLI help -s, --nosandbox Uses the --no-sandbox flag for performing actions requiring chromium --dockerRegistryPassword=dockerRegistryPassword (required) [default: password] Docker registry (i.e. docker hub) password --dockerRegistryUsername=dockerRegistryUsername (required) [default: username] Docker registry (i.e. docker hub) username --file=file Filepath of the archive to be imported --jahiaAdminPassword=jahiaAdminPassword (required) [default: root] Jahia Administrator interface Password --jahiaAdminUrl=jahiaAdminUrl (required) [default: http://localhost:8080] Jahia Administrator interface URL --jahiaAdminUsername=jahiaAdminUsername (required) [default: root] Jahia Administrator interface Username --jahiaToolsPassword=jahiaToolsPassword (required) [default: password] Jahia Tools Password --jahiaToolsUsername=jahiaToolsUsername (required) [default: jahia] Jahia Tools (modules/tools) Username --output=output Output values to the filesystem (such as payload) --sitekey=sitekey (required) Site Key of the project to be imported --type=file|prepackaged (required) [default: prepackaged] Specify if you want to import by file or by prepackaged site ``` _See code: [src/commands/webprojects/import.ts](https://github.com/jahia/jahia-cli/blob/v0.0.70/src/commands/webprojects/import.ts)_ ## `jahia-cli webprojects:installed [FILE]` List installed Web Projects ``` List installed Web Projects USAGE $ jahia-cli webprojects:installed [FILE] OPTIONS -d, --debug Enable debug mode (display chrome browser) -h, --help show CLI help -s, --nosandbox Uses the --no-sandbox flag for performing actions requiring chromium --dockerRegistryPassword=dockerRegistryPassword (required) [default: password] Docker registry (i.e. docker hub) password --dockerRegistryUsername=dockerRegistryUsername (required) [default: username] Docker registry (i.e. docker hub) username --jahiaAdminPassword=jahiaAdminPassword (required) [default: root] Jahia Administrator interface Password --jahiaAdminUrl=jahiaAdminUrl (required) [default: http://localhost:8080] Jahia Administrator interface URL --jahiaAdminUsername=jahiaAdminUsername (required) [default: root] Jahia Administrator interface Username --jahiaToolsPassword=jahiaToolsPassword (required) [default: password] Jahia Tools Password --jahiaToolsUsername=jahiaToolsUsername (required) [default: jahia] Jahia Tools (modules/tools) Username --output=output Output values to the filesystem (such as payload) ``` _See code: [src/commands/webprojects/installed.ts](https://github.com/jahia/jahia-cli/blob/v0.0.70/src/commands/webprojects/installed.ts)_ --- _Source: https://npm.io/package/jahia-cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._