bam

---

title: bam cli

bam v1

A command-line utility that retrieves a project from a git repository.

npx bam github:twilson63/webapp helloworld

The bam command will download and extract the archive of the master branch into a new folder specified by the second argument.

The cli takes two arguments:

bam [source] [target]

The source argument uses the current format:

[remote]:[org]/[repo]#[branch]

• remote is either 'github' or 'gitlab'
• org is either the organization or username
• repo is the project name
• branch is master or a branch name

Elevator Pitch

For developers who want to consistently start projects using their setup scripts, bam is a cli that is lightweight and easy to use, unlike large bootstrap clis, bam is simple and focused and supports any git repository that archives their branches in gzip.

Benefits

• Every project setup needs boilier-plate, bam gives you a quick way to get up and running.
• Modifying your setup scripts is easy with github, with bam using them is easier.
• Great for providing students easy projects to get started on without having to dive into git.

Not in scope

• scaffolding or generating code
• working with git semantics
• executing npm installs or other init scripts

Solution

Single command-line interface that takes two arguments:

• location of the repository: gitlab:twilson63/template
• target directory: my-app

Contributions

All contributions are welcome.

LICENSE

see LICENSE