Skip to content

Basic working repo structure for Adobe teams to use as a starting point for their own plugins.

License

Notifications You must be signed in to change notification settings

adobe/aio-cli-plugin-boilerplate

aio-cli-plugin-boilerplate

Basic working repo structure for Adobe teams to use as a starting point for their own plugins, and available as a github template to the @adobe github org.

How to use this template

  • create a new repo from the github.com/adobe and select it in the templates
  • give it a unique name ( plugins are typically named aio-cli-plugin-xxxx )
  • enter a description
  • pick options
  • create repository
  • git clone, npm i
  • make some changes to names of things readme, ...
  • git add .
  • git commit -m 'A new begining'

How to use this repo, ( like a repo )

  • Click 'Clone or Download' and download a zip

  • extract it to a directory on your machine

  • if you cloned, delete the hidden .git folder

  • run git init

  • make some changes to names of things readme, ...

  • git add .

  • git commit -m 'A new begining'

  • Create the new empty repo here on github

  • grab the remote url

back in your directory ...

  • git remote add origin new-repo-url
  • git push origin master

PLUGINNAME commands for the Adobe I/O CLI

Usage

$ aio plugins:install @adobe/aio-cli-plugin-PLUGINNAME
$ # OR
$ aio discover -i
$ aio PLUGINNAME --help

Commands

aio help [COMMAND]

Display help for aio.

USAGE
  $ aio help [COMMAND...] [-n]

ARGUMENTS
  COMMAND...  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for aio.

See code: @oclif/plugin-help

aio PLUGINNAME

Your description here

USAGE
  $ aio PLUGINNAME

DESCRIPTION
  Your description here

aio PLUGINNAME hello [NAME]

A hello world sample command.

USAGE
  $ aio PLUGINNAME hello [NAME] [-f <value>]

ARGUMENTS
  NAME  name to print

FLAGS
  -f, --someflag=<value>  this is some flag

DESCRIPTION
  A hello world sample command.

EXAMPLES
  $ aio PLUGINNAME:hello myself -f myflag

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.

About

Basic working repo structure for Adobe teams to use as a starting point for their own plugins.

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •