Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/shazron/aio-cli-plugin-app-templates

Last synced: 3 months ago
JSON representation

Host: GitHub
URL: https://github.com/shazron/aio-cli-plugin-app-templates
Owner: shazron
License: apache-2.0
Fork: true (adobe/aio-cli-plugin-app-templates)
Created: 2022-07-26T02:47:59.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2024-05-14T23:58:31.000Z (8 months ago)
Last Synced: 2024-05-15T18:39:18.410Z (8 months ago)
Language: JavaScript
Size: 110 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

# aio-cli-plugin-app-templates

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

---

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
[![Version](https://img.shields.io/npm/v/@adobe/aio-cli-plugin-app-templates.svg)](https://npmjs.org/package/@adobe/aio-cli-plugin-app-templates)
[![Downloads/week](https://img.shields.io/npm/dw/@adobe/aio-cli-plugin-app-templates.svg)](https://npmjs.org/package/@adobe/aio-cli-plugin-app-templates)
![Node.js CI](https://github.com/adobe/aio-cli-plugin-app-templates/workflows/Node.js%20CI/badge.svg)
[![Github Pull Requests](https://img.shields.io/github/issues-pr/adobe/aio-cli-plugin-app-templates.svg)](https://github.com/adobe/aio-cli-plugin-app-templates/pulls)
[![Codecov Coverage](https://img.shields.io/codecov/c/github/adobe/aio-cli-plugin-app-templates/main.svg?style=flat-square)](https://codecov.io/gh/adobe/aio-cli-plugin-app-templates/)

* [aio-cli-plugin-app-templates](#aio-cli-plugin-app-templates)
* [Usage](#usage)
* [Commands](#commands)
* [Contributing](#contributing)
* [Licensing](#licensing)

# Usage

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

# Commands

* [`aio templates`](#aio-templates)
* [`aio templates discover`](#aio-templates-discover)
* [`aio templates info`](#aio-templates-info)
* [`aio templates install PATH`](#aio-templates-install-path)
* [`aio templates remove NAME`](#aio-templates-remove-name)
* [`aio templates rollback`](#aio-templates-rollback)
* [`aio templates submit NAME GITHUBREPOURL`](#aio-templates-submit-name-githubrepourl)
* [`aio templates uninstall PACKAGE-NAME`](#aio-templates-uninstall-package-name)

## `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.js](https://github.com/adobe/aio-cli-plugin-app-templates/blob/2.0.2/src/commands/templates/index.js)_

## `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= [default: adobeRecommended] which column to sort, use the sort-order flag to specify sort
direction

-i, --interactive interactive install mode
-o, --sort-order= [default: desc] sort order for a column, use the sort-field flag to specify which column to
sort

-v, --verbose Verbose output

DESCRIPTION
Discover App Builder templates to install

ALIASES
$ aio templates disco
```

_See code: [src/commands/templates/discover.js](https://github.com/adobe/aio-cli-plugin-app-templates/blob/2.0.2/src/commands/templates/discover.js)_

## `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.js](https://github.com/adobe/aio-cli-plugin-app-templates/blob/2.0.2/src/commands/templates/info.js)_

## `aio templates install PATH`

Install an Adobe Developer App Builder template

```
USAGE
$ aio templates install PATH [-v] [-y] [--install] [--process-install-config] [--template-options ]

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= 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.js](https://github.com/adobe/aio-cli-plugin-app-templates/blob/2.0.2/src/commands/templates/install.js)_

## `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.js](https://github.com/adobe/aio-cli-plugin-app-templates/blob/2.0.2/src/commands/templates/remove.js)_

## `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.js](https://github.com/adobe/aio-cli-plugin-app-templates/blob/2.0.2/src/commands/templates/rollback.js)_

## `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.js](https://github.com/adobe/aio-cli-plugin-app-templates/blob/2.0.2/src/commands/templates/submit.js)_

## `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.js](https://github.com/adobe/aio-cli-plugin-app-templates/blob/2.0.2/src/commands/templates/uninstall.js)_

# Contributing

Contributions are welcomed! Read the [Contributing Guide](./CONTRIBUTING.md) for more information.

# Licensing

This project is licensed under the Apache V2 License. See [LICENSE](./LICENSE) for more information.