@adobe/aio-cli-plugin-app-templates

2.0.3 • Public • Published

aio-cli-plugin-app-templates

Discover, Install, Uninstall, Submit, and Remove Adobe App Builder templates


License oclif Version Downloads/week Codecov Coverage Github Issues Github Pull Requests

Usage

aio plugins:install @adobe/aio-cli-plugin-app-templates
## OR
aio discover -i
aio aio-cli-plugin-app-templates --help

Commands

aio templates

Discover, install, or uninstall a new template into an existing Adobe Developer App Builder App

USAGE
  $ aio templates [-v]

FLAGS
  -v, --verbose  Verbose output

DESCRIPTION
  Discover, install, or uninstall a new template into an existing Adobe Developer App Builder App

See code: src/commands/templates/index.ts

aio templates discover

Discover App Builder templates to install

USAGE
  $ aio templates discover [-v] [-i] [-f publishDate|names|adobeRecommended] [-o asc|desc]

FLAGS
  -f, --sort-field=<option>  [default: adobeRecommended] which column to sort, use the sort-order flag to specify sort
                             direction
                             <options: publishDate|names|adobeRecommended>
  -i, --interactive          interactive install mode
  -o, --sort-order=<option>  [default: desc] sort order for a column, use the sort-field flag to specify which column to
                             sort
                             <options: asc|desc>
  -v, --verbose              Verbose output

DESCRIPTION
  Discover App Builder templates to install

ALIASES
  $ aio templates disco

See code: src/commands/templates/discover.ts

aio templates info

List all App Builder templates that are installed

USAGE
  $ aio templates info [-v] [-y | -j] [-s]

FLAGS
  -j, --json               output raw json
  -s, --required-services  includes services required by a template in the output
  -v, --verbose            Verbose output
  -y, --yml                output yml

DESCRIPTION
  List all App Builder templates that are installed

See code: src/commands/templates/info.ts

aio templates install PATH

Install an Adobe Developer App Builder template

USAGE
  $ aio templates install PATH [-v] [-y] [--install] [--process-install-config] [--template-options <value>]

ARGUMENTS
  PATH  path to the template (npm package name, file path, url). See examples

FLAGS
  -v, --verbose                      Verbose output
  -y, --yes                          Skip questions, and use all default values
      --[no-]install                 [default: true] Run npm installation after files are created
      --[no-]process-install-config  [default: true] Process the template install.yml configuration file, defaults to
                                     true, to skip processing install.yml use --no-process-install-config
      --template-options=<value>     Additional template options, as a base64-encoded json string

DESCRIPTION
  Install an Adobe Developer App Builder template

ALIASES
  $ aio templates i

EXAMPLES
  $ aio templates install https://github.com/org/repo

  $ aio templates install git+https://github.com/org/repo

  $ aio templates install ssh://github.com/org/repo

  $ aio templates install git+ssh://github.com/org/repo

  $ aio templates install file:../relative/path/to/template/folder

  $ aio templates install file:/absolute/path/to/template/folder

  $ aio templates install ../relative/path/to/template/folder

  $ aio templates install /absolute/path/to/template/folder

  $ aio templates install npm-package-name

  $ aio templates install npm-package-name@tagOrVersion

  $ aio templates install @scope/npm-package-name

  $ aio templates install @scope/npm-package-name@tagOrVersion

See code: src/commands/templates/install.ts

aio templates remove NAME

Remove an Adobe Developer App Builder template from the Template Registry

USAGE
  $ aio templates remove NAME [-v]

ARGUMENTS
  NAME  The name of the package implementing the template on npmjs.com

FLAGS
  -v, --verbose  Verbose output

DESCRIPTION
  Remove an Adobe Developer App Builder template from the Template Registry

ALIASES
  $ aio templates rm

EXAMPLES
  $ aio templates remove @adobe/app-builder-template

See code: src/commands/templates/remove.ts

aio templates rollback

Clears all installed templates

USAGE
  $ aio templates rollback [-v] [-i] [-l] [-c]

FLAGS
  -c, --[no-]confirm  confirmation needed for clear (defaults to true)
  -i, --interactive   interactive clear mode
  -l, --list          list templates that will be uninstalled
  -v, --verbose       Verbose output

DESCRIPTION
  Clears all installed templates

See code: src/commands/templates/rollback.ts

aio templates submit NAME GITHUBREPOURL

Submit an Adobe Developer App Builder template

USAGE
  $ aio templates submit NAME GITHUBREPOURL [-v]

ARGUMENTS
  NAME           The name of the package implementing the template on npmjs.com
  GITHUBREPOURL  A link to the Github repository containing the package's source code

FLAGS
  -v, --verbose  Verbose output

DESCRIPTION
  Submit an Adobe Developer App Builder template

ALIASES
  $ aio templates sub

EXAMPLES
  $ aio templates submit @adobe/app-builder-template https://github.com/adobe/app-builder-template

See code: src/commands/templates/submit.ts

aio templates uninstall PACKAGE-NAME

Uninstall an Adobe Developer App Builder template

USAGE
  $ aio templates uninstall PACKAGE-NAME [-v]

ARGUMENTS
  PACKAGE-NAME  package name of the template

FLAGS
  -v, --verbose  Verbose output

DESCRIPTION
  Uninstall an Adobe Developer App Builder template

ALIASES
  $ aio templates un

See code: src/commands/templates/uninstall.ts

Contributing

Contributions are welcomed! Read the Contributing Guide for more information.

Licensing

This project is licensed under the Apache V2 License. See LICENSE for more information.

Readme

Keywords

Package Sidebar

Install

npm i @adobe/aio-cli-plugin-app-templates

Weekly Downloads

2,634

Version

2.0.3

License

Apache-2.0

Unpacked Size

83.5 kB

Total Files

17

Last publish

Collaborators

  • dylandepass
  • djaeggi
  • adobehalls
  • fullcolorcoder
  • marbec
  • tripod
  • garthdb
  • lazd
  • adobe-admin
  • patrickfulton
  • trieloff
  • shazron
  • krisnye
  • dcpfsdk
  • natebaldwin
  • devongovett
  • aspro83
  • symanovi
  • dpfister
  • stefan-guggisberg
  • korra
  • rofe
  • kptdobe