aniftyco / groundwork

Scaffold out any project quickly

Groundwork

Scaffold out any project quickly

Usage

npx groundwork@latest org/repo path/

When first ran, this will fetch and cache $CACHE/org/repo/{version}.tar.gz tarball and extract it to $PWD/path/. If there are no tagged releases, Groundwork will fallback to the default branch of the repo.

You can pass a hash to the template to specify a commit/branch/tag to scaffold from, for example

npx groundwork@latest org/repo#development path/

And that will fetch and cache $CACHE/org/repo/development.tar.gz tarball before extracting it.

You can pass --force to force it to redownload the tarball otherwise it will always pull from cache if exists.

npx groundwork@latest login

And you will get prompted to supply a github personal token. This will allow you to use private repos as your groundwork scaffolding.