Skip to content

zpeters/stashbox

Repository files navigation

stashbox

Go Build Go Test Go Lint Gosec CodeQL Go Report Card License Contributers gopherbadger-tag-do-not-edit

Stashbox is your personal Internet Archive

The goal of stashbox is to help you create your own - personal copy of websites that you wish to archive.

The initial way to do this will be to run a simple command, but in the future it can be extended to a web interface, a plugin or other means.

Having a local "static" copy of a website can help for research, change tracking and for many other purposes

Roadmap

  • Initial command line client to add urls to a personal archive with Text, Html and Pdf copies of the website
  • Ability to save new versions of the same URL
  • Version "diffing" and browsing
  • User friendly interface (web, etc)
  • Searching and other functions

Usage

Usage: stashbox <command> <options>

  Where command is one of:
    add   --  add a url to the archive
      -b string
            stashbox archive directory (defaults to ./stashDb) (default "./stashDb")
      -u string
            url to download
    list  --  list all archives
      -b string
            stashbox archive directory (defaults to ./stashDb) (default "./stashDb")
    open  --  open an archive
      -b string
            stashbox archive directory (defaults to ./stashDb) (default "./stashDb")
      -n int
            archive number to open (from list command)

  To see help text, you can run:
    stashbox <command> -h

Contributing

New issues and pull requests are welcomed. Please see CONTRIBUTING.md

Contributors

Made with contributors-img.