gpkg

command module
v0.1.6 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 15, 2020 License: MIT Imports: 1 Imported by: 0

README

build codecov Go Report Card PkgGoDev Gitter

The (Unofficial) Github Package Manager

Package management using Github repositories.

About

This tool was built to solve the problem of manually installing and managing software from Github Releases.

The aim of this tool is to provide these kinds of semantics to enable users to quickly install tools with commands like gpkg install github.com/${OWNER}/${REPO}.

Installation

There are several methods available to install the gpkg cli, the simplest and fastest way is to install the latest release from our site:

curl --proto '=https' --tlsv1.2 -sSf https://gpkg.dev/install.sh | bash

If you want to install a specific version instead of the latest release you can add an environment variable to indicate which release you want:

curl --proto '=https' --tlsv1.2 -sSf https://gpkg.dev/install.sh | GPKG_VERSION=v0.1.3 bash

Once you've installed gpkg this way it becomes self-hosting and going forward it can update itself with gpkg update self.

Add ~/.local/gpkg/bin to your PATH environment variable permanently at this point to run gpkg and other apps installed via gpkg.

Usage

The following are several usage examples using the Github CLI package from the default package repository.

To see a list of all available packages run gpkg repository list, and to search for specific packages run gpkg repository search <name>.

You can view the currently installed packages on your system with gpkg packages list.

Examples - Install

Install the latest release for a package:

gpkg install github.com/cli/cli

Install the latest release for a package allowing pre-releases as valid release targets:

gpkg install --enable-prereleases github.com/cli/cli

Install a specific release version for a package

gpkg install github.com/cli/cli v0.11.0

Examples - Update

To update to the latest minor and patch version available:

gpkg update github.com/cli/cli

To update to the latest minor and patch version available allowing pre-releases as valid release targets:

gpkg update --enable-prereleases github.com/cli/cli

To update to a specific version:

gpkg update github.com/cli/cli v0.11.1

Note that updating to a specific version is also how you would update to the latest major version of a package, as major version jumps are not enabled for automation by default.

Examples - Uninstall

gpkg uninstall github.com/cli/cli

Goals

To track current goals and their progress check the Organization's Projects.

Contributing

See the Contributing Guide and the Developer Docs.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
internal
pkg
constants
Package constants contains constants and variables used throughout the module for default settings and commonly used names
Package constants contains constants and variables used throughout the module for default settings and commonly used names
errors
Package errors provides pre-formatted errors that are used throughout the module
Package errors provides pre-formatted errors that are used throughout the module
packages
Package packages provides types and functionality for handling application packages from Github repositories
Package packages provides types and functionality for handling application packages from Github repositories
test

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL