Archives
/
bpkg
mirror of https://github.com/bpkg/bpkg
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
allow-local-directory-global-install
master
lint-cleanup
bug/bpkg-init-name
devops
github-actions
0.0.2
0.0.3
0.0.4
0.0.5
0.0.6
0.0.7
0.0.8
0.0.9
0.1.0
0.2.0
0.2.1
0.2.2
0.2.3
0.2.4
0.2.5
0.2.6
0.2.7
0.2.8
0.2.9
0.3.0
0.3.1
0.3.2
1.0.0
1.0.1
1.0.10
1.0.11
1.0.12
1.0.13
1.0.14
1.0.15
1.0.16
1.0.17
1.0.18
1.0.19
1.0.2
1.0.20
1.0.21
1.0.22
1.0.23
1.0.24
1.0.25
1.0.3
1.0.4
1.0.5
1.0.6
1.0.7
1.0.8
1.0.9
1.1.0
1.1.1
1.1.2
1.1.3
1.1.4
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'e488607fc9'
${ noResults }
bpkg/README.md

2.5 KiB
Raw Blame History

bpkg

Lightweight bash package manager

install

Install script:

$ curl -Lo- https://raw.githubusercontent.com/bpkg/bpkg/master/install.sh | bash

clib:

$ clib install bpkg/bpkg

source:

$ git clone https://github.com/bpkg/bpkg.git
$ cd bpkg
$ make install

usage

installing package

global:

$ bpkg install term -g

project: (installs into deps/)

$ bpkg install term

versioned:

$ bpkg install jwerle/suggest.sh@0.0.1 -g

note: Versioned packages must be tagged releases by the author.

package info

From the root of a package directory:

$ bpkg package name
 "bpkg"

$ bpkg package version
 "0.0.5"

$ bpkg package
["name"]        "bpkg"
["version"]     "0.0.5"
["description"] "Lightweight bash package manager"
["global"]      true
["install"]     "make install"

package.json

name

The name attribute is required as it is used to tell bpkg where to put it in the deps/ directory in you project.

  "name": "my-script"

version

The version attribute is not required but can be useful. It should correspond to the version that is associated with the installed package.

  "version": "0.0.1"

description

A human readable description of what the package offers for functionality.

  "description": "This script makes monkeys jump out of your keyboard"

global

Indicates that the package is only intended to be install as a script. This allows the ommition of the -g or --global flag during installation.

  "global": "true"

install

Shell script used to invoke in the install script. This is required if the global attribute is set to true or if the -g or --global flags are provided.

  "install": "make install"

scripts

This is an array of scripts that will be installed into a project.

  "scripts": ["script.sh"]

best practices

package exports

Its nice to have a bash package that can be used in the terminal and also be invoked as a command line function. To achieve this the exporting of your functionality should follow this pattern:

if [[ ${BASH_SOURCE[0]} != $0 ]]; then
  export -f my_script
else
  my_script "${@}"
  exit $?
fi

This allows a user to source your script or invoke as a script.

$ ./my_script.sh some args --blah

or

$ source my_script.sh
$ my_script some more args --blah

license

MIT