Git Product home page Git Product logo

aio-cli-plugin-boilerplate's Introduction

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.

aio-cli-plugin-boilerplate's People

Contributors

moritzraho avatar purplecabbage avatar shazron avatar yu1986 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.