ericcrosson / usable

An interface for projects to expose quick-start functionality

Usable

An interface for exposing hosted-projects via one-liners

usable defines and implements an interface for easily using a hosted project.

Note: this interface is currently under initial development and is subject to change without notice. Hold off until release 1.0.0 for more stability.

API

Note that all target projects will be cloned into the current working directory.

apply

Clone the specified repository and invoke its /bin/apply script. Arguments are passed to git clone.

run

Similar to apply, but only accepts one argument to git clone -- the target repository. Additional arguments indicate the script inside the repository to invoke and any arguments for it.

Tip: Use run over apply when the clone invocation is simple but the script invocation is not

Use

To use an available command

curl -fsSL https://raw.githubusercontent.com/EricCrosson/usable/master/bin/<COMMAND> | bash -s -- <ARGUMENTS>

replace <COMMAND> with the desired action from the usable interface along with its <ARGUMENTS>.

usable's Issues

Make an awesome badge

much like https://github.com/sindresorhus/awesome/blob/master/media/badge.svg

Pass all args to target_script in run

Add flag

--verbose

for debugging on-the-spot

Make usable more usable

e.g. provide a simple way to access the hosted api from one's command line

Accept flag to destroy artifacts on local disk after successful run

e.g. the cloned git repository

Use `sh` instead of `bash` for portability

Add ci

Add license

ISC