https://github.com/ishbguy/bag
A bash packages and plugins manager.
https://github.com/ishbguy/bag
bash cli package-manager plugin-manager shell
Last synced: about 1 month ago
JSON representation
A bash packages and plugins manager.
- Host: GitHub
- URL: https://github.com/ishbguy/bag
- Owner: ishbguy
- License: mit
- Created: 2018-06-22T13:41:15.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2025-03-04T19:32:12.000Z (over 1 year ago)
- Last Synced: 2026-05-03T21:37:16.486Z (about 1 month ago)
- Topics: bash, cli, package-manager, plugin-manager, shell
- Language: Shell
- Size: 71.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [bag](https://github.com/ishbguy/bag)
[![Version][versvg]][ver] [![License][licsvg]][lic]
[versvg]: https://img.shields.io/badge/version-v1.0.0-lightgrey.svg
[ver]: https://img.shields.io/badge/version-v1.0.0-lightgrey.svg
[licsvg]: https://img.shields.io/badge/license-MIT-green.svg
[lic]: https://github.com/ishbguy/bag/blob/master/LICENSE
**bag** is a bash package and plugin manager which inspired by [vim-plug](https://github.com/junegunn/vim-plug).
## Table of Contents
+ [:art: Features](#art-features)
+ [:straight_ruler: Prerequisite](#straight_ruler-prerequisite)
+ [:rocket: Installation](#rocket-installation)
+ [:notebook: Usage](#notebook-usage)
+ [:memo: Configuration](#memo-configuration)
+ [:hibiscus: Contributing](#hibiscus-contributing)
+ [:boy: Authors](#boy-authors)
+ [:scroll: License](#scroll-license)
## :art: Features
+ Basic packges and plugins management: install, update or uninstall.
+ Customizable to support different downloader: local repos, git repos or cloud drive repos.
## :straight_ruler: Prerequisite
> + `bash` 4.2 or later
> + `git`
## :rocket: Installation
``` bash
$ git clone https://github.com/ishbguy/bag /path/to/bag
```
or
```bash
$ curl -fLo /path/to/bag.sh --create-dirs \
https://raw.githubusercontent.com/ishbguy/bag/master/bag.sh
```
## :notebook: Usage
The only action you need to do is to add below instruction in your bash config file: `~/.bashrc` or `~/.bash_profile`:
```bash
[[ -f /path/to/bag.sh ]] && source /path/to/bag.sh
```
After login `bash`, you can use `bag` command to manage packges and plugins. `bag help` will print usage.
```
bag v1.1.0
bag [somthing]
subcmds:
agent agent for other package or repo operation cmd
base [path] change or list bags download directory
edit edit bag list
help show help message, like this output
install [dl:url] install a bag
link add an existed package or repo by symbolic link
list list installed bags
load load all plugins and update PATH
plug [dl:url] add a bag plugin or list all plugins
uninstall uninstall a bag
unlink unlink a bag, just like uninstall
update [pat] update one or more bags
version show version number
like 'gh:ishbguy/bag' means that it will install or update bag
from https://github.com/ishbguy/bag by github downloader.
If prefix with '@' like '@gh:ishbguy/bag', that means it will run
all the autoload/*.sh scripts under the bag directory.
If suffix with '#!.*' like 'gh:ishbguy/bag#!echo hello', that means
it will run the post-install hook 'echo hello'.
downloaders:
file alias for local downloader
gh alias for github downloader
git downloader for git repo
github downloader for github repo
link downloader for local file or directory as symbolic link
local downloader for local file or directory
bag list usage:
bag list [options]
options:
list without option will list all bags
-a|--all|all list all bags include autoload notation(@)
and post install cmd(#!)
-@|@|--autoload|autoload list autoload bags without '@' or '#!' string
-p|--post|post list bags configured post install cmd but
without '#!' cmd string
-h|--help|help print this help message
bag agent usage:
bag agent [args..]
actions:
add add an agent cmd, need to be quoted
del delete an agent cmd, need to be quoted
run [cmd-pat] run all or a pattern matched agent cmd
edit edit the agent file
list list all added agent cmd
help print the bag agent help message like this
This program is released under the terms of MIT License.
Get more infomation from .
```
### Examples
1. Use bag like other package management tools:
```bash
bag install gh:ishbguy/bag
bag update gh:ihsbguy/bag
bag uninstall gh:ishbguy/bag
```
2. Use bag as a plugin management tool, you need to add instructions to `~/.bashrc` or `~/.bash_profile`:
```bash
bag base $HOME/.bags
bag plug gh:ishbguy/bag
bag install
bag load
```
3. Define your own `bag_downloader_XXX`
```bash
# Define your own github downloader
bag_downloader_github() {
__bag_require git || return 1
# get two args
local bag_opt="$1"
local bag_url="https://github.com/${2#*:}"
local bag=$(__bag_get_bag_name "$bag_url")
# implement the install and update operations
case $bag_opt in
install) git clone "$bag_url" "$BAG_BASE_DIR/$bag" ;;
update) (cd "$BAG_BASE_DIR/$bag" && git pull) ;;
*) __bag_error "No such option: $bag_opt" ;;
esac
}
# Write the help message, then install it
BAG_DOWNLOADER_HELP[github]="downloader for github repo"
BAG_DOWNLOADER[github]="bag_downloader_github"
```
## :memo: Configuration
The default `BAG_BASE_DIR` is `$HOME/.bags`, you can change it by `bag base ` or `export BAG_BASE_DIR=$DIR_PATH`.
## :hibiscus: Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
## :boy: Authors
+ [ishbguy](https://github.com/ishbguy)
## :scroll: License
Released under the terms of [MIT License](https://opensource.org/licenses/MIT).