Skip to content
Kaya-Sem edited this page Jul 29, 2024 · 3 revisions

backpack-cli features the following commands:

create: create items and collections

add: add items to collections

remove: remove items from collections

edit: edit items and collections

list: list items, collections and categories

view: view/inspect items and collections

delete: delete items and collections

checklist: export a collection as a markdown or pdf checklist

import-lighterpack: import a lighterpack CSV

When using the command line utility, you can append --help to a command, to show how you can use it.


list

Display a list of your collections, items, or categories.

backpack list [collections | items | categories]

add

Add items to a collection. Takes any number of item IDs separated by spaces, and a collection specified with --collection

backpack add item 1 2 --collection 4

remove

Remove items from a collection. Takes any number of item IDs separated by spaces, and a collection specified with --collection

backpack remove item 4 5 --collection 6

create

Create a new collection or item.

backpack create [collection | item]

collection: You can either create a collection by specifying a name and description:

-n|--name "name" -d|--description "description"

or use the interactive mode:

create collection -i / --interactive

item: when given no arguments, it will create an item interactively. Otherwise, you can use options

  • -n / --name for item name
  • -w / --weight for item weight in grams
  • -c / --category for item category
  • --note for item note

delete

Delete an existing collection or item.

backpack delete [collection | item] [ID]

view

View details of a collection or item.

backpack view [collection | item]

checklist

Export a collection as a markdown or PDF checklist.

backpack checklist --collection [ID]
backpack checklist --collection [ID] --pdf
Clone this wiki locally