bpkg

A lightweight Bash package manager

Type object
File match bpkg.json
Schema URL https://catalog.lintel.tools/schemas/schemastore/bpkg/latest.json
Source https://www.schemastore.org/bpkg.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

name string required

Where the dependency is located in deps/.

See more: https://github.com/bpkg/bpkg#name

Default: ""
description string required

Human-readable description of the functionality of the package.

See more: https://github.com/bpkg/bpkg#description

Examples: "Terminal utility functions"
global string required

Whether the package is only intended be installed as a global script. Allows the omission of the --global flag when installing.

See more: https://github.com/bpkg/bpkg#global

Default: ""
Examples: "true"
install string required

Shell script used to invoke in the install script. Required if package is being installed as a global script.

See more: https://github.com/bpkg/bpkg#install-1

Default: "make install"
Examples: "make install"
scripts string[] required

An array of scripts to install into a project. See more: https://github.com/bpkg/bpkg#scripts

version string

The current version of the dependency.

See more: https://github.com/bpkg/bpkg#version-optional

Default: "v0.1.0"
files string[]

An array of non-script files to install into a project. See more: https://github.com/bpkg/bpkg#files-optional

dependencies Record<string, string>

Hash of dependencies of this project. Use either a tagged release identifier or master.

See more: https://github.com/bpkg/bpkg#dependencies-optional

dependencies-dev Record<string, string>

Hash of development dependencies of this project. Use either a tagged release identifier or master.

See more: https://github.com/bpkg/bpkg#dependencies-dev-optional

commands Record<string, string>

A hash of runnable commands for bpkg run.

See more: https://github.com/bpkg/bpkg#commands-optional

commands-description Record<string, string>

A hash of descriptions for each command in commands.

See more: https://github.com/bpkg/bpkg#commands-description-optional