Bagoo

A simple CLI tool for storing your favourite commands or for holding onto short notes

Installation

npm install bagoo -g

Usage

An item in baggo consists of:

• name to identify the item
• value for the item
• description to help explain what the item is or does
• category to group related items together

NOTE: This tool stores items in a JSON file. Storage is very basic and is not suitable for storing sensitive information such as passwords or secrets.

Available commands

• add - an item to your bag
• get - retrieve an item
• list - lists all available catagories or lists all items within a category
• remove - an item or all items from your bag
• copy - creates a copy of your bag at another location
• config - configure the location of your bag

Adding an item to baggo

• --name | -n (mandatory)
• --value | -v (mandatory)
• --description | -d (optional)
• --category | -c (optional - defaults to "other")

example:

bag add -n="make directory" -v="mkdir" -c="linux commands" -d="Linux command for creating a new directory"

Getting an item from bagoo

• --name | -n (mandatory)

Returns all properties for the specified item.

Example

bag get -n="make directory"

Returns

category: linux commands
description: command for creating a new directory
value: mkdir

Optionally specify one of:

• --value | -v
• --category | -c
• --description | -d

Will return the the value of the property specified for the item.

Example

bag get -n="make directory" -v

Returns

mkdir

Listing items

Lists all available catagories within baggo.

Example

bag list

Returns

Available catagories:
- linux commands
- favourite animals
- recipes
- something else

Specifying a category will list all items within that category and display the item name and its description.

Example

bag list -c="linux commands"

Returns

Items recorded under linux commands:
- make directory : Linux command for creating a new directory
- another item : A description of another item... 

Removing an item

You can remove a specific item.

Example

bag remove -n="make directory"

Returns

Removed make directory from your bag

Or remove all items by adding the --purge | -p flag.

Example

bag remove -p

You will then be prompted.

This action will remove all items in your bag, are you sure?: (Y/N): 

Copying your bag to another location

You might wish to copy your bag so you can use it elsewhere.

Example

bag copy

You will then be prompted.

Enter the path to where you want to export your bag to:

Enter the path of where you want to copy the bag to. i.e /home/documents

You will then be notfied.

Copying your bag to /home/documents

Configuring the location of your bag

Copy your bag to your chosen location and then configure bagoo to point to the new location.

• --location | -l (mandatory)

Example

bag config -l="/home/documents"

You will then be notfied.

Location of your bag has been set to '/home/documents'

Development

Dependencies

• app-root-path: ^3.0.0
• prompt: ^1.1.0
• shelljs: ^0.8.4
• yargs: ^16.2.0
• jest: ^16.2.0

Running unit tests

npm run test