From 6112d50412e7ef6e04b1901b2cc78b8334feb579 Mon Sep 17 00:00:00 2001 From: Paul Selibas Date: Sat, 18 Dec 2021 22:47:49 +0100 Subject: [PATCH] Update Readme --- README.md | 46 ++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 44 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9fffbf0..f8334ad 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,44 @@ -# bblocal -Run Bitbucket pipeline files locally +# Run Bitbucket Pipeline Locally +It can be a slow process when developing a bitbucket-pipeline.xml file. +The intention of this tool is to run a bitbucket-pipeline.xml file locally in order to speed up the development process. + +--- +**WARNING** + +Do not use this tool to generate and build your software that you plan to use in production. + +This project is still a work in progress and still incomplete. + +--- + +## Install + +Install `bblocal` with `npm`: + +```bash +$ npm install -g bblocal +``` + +## Usage + +``` + Usage: bblocal [options] + + An application for running bitbucket pipeline files locally. This tool is intended to help debug and create pipeline files. + + Options: + -V, --version output the version number + -f, --file bitbucket pipeline file (default: "bitbucket-pipelines.yml") + -p, --pipeline Specify which pipeline to execute (default: "default") + -s, --source Specify the source folder (default: "./") + -a, --artifacts Location of artifacts tar file (default: "./.bblocal/artifacts.tar") + -c, --cache Folder to store cache for this build (default: "./.bblocal/cache") + -h, --help display help for command + +``` + +## Logic +1. Step 1 //TODO + +## Acknowledgements +- Inspiration for this project was take from [this project](https://github.com/mserranom/bbrun)