Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zpeters/stashbox
Your personal Internet Archive
https://github.com/zpeters/stashbox
go golang hacktoberfest hacktoberfest2020 personal-archive self-hosted
Last synced: about 1 month ago
JSON representation
Your personal Internet Archive
- Host: GitHub
- URL: https://github.com/zpeters/stashbox
- Owner: zpeters
- License: gpl-3.0
- Created: 2020-10-01T00:56:15.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-02-29T16:35:17.000Z (11 months ago)
- Last Synced: 2024-08-10T11:02:37.999Z (5 months ago)
- Topics: go, golang, hacktoberfest, hacktoberfest2020, personal-archive, self-hosted
- Language: Go
- Homepage:
- Size: 141 KB
- Stars: 46
- Watchers: 4
- Forks: 20
- Open Issues: 30
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# stashbox
![Go Build](https://github.com/zpeters/stashbox/workflows/Go%20Build/badge.svg)
![Go Test](https://github.com/zpeters/stashbox/workflows/Go%20Test/badge.svg)
![Go Lint](https://github.com/zpeters/stashbox/workflows/Go%20Lint/badge.svg)
![Gosec](https://github.com/zpeters/stashbox/workflows/Gosec/badge.svg)
![CodeQL](https://github.com/zpeters/stashbox/workflows/CodeQL/badge.svg)
[![Go Report Card](https://goreportcard.com/badge/github.com/zpeters/stashbox)](https://goreportcard.com/report/github.com/zpeters/stashbox)
[![License](https://img.shields.io/github/license/zpeters/stashbox)](https://img.shields.io/github/license/zpeters/stashbox)
[![Contributers](https://img.shields.io/github/contributors/zpeters/stashbox)](https://img.shields.io/github/contributors/zpeters/stashbox)
![gopherbadger-tag-do-not-edit](https://github.com/KrishKayc/stashbox/blob/add-code-coverage-badge/coverage/coverage_badge.png)
## Stashbox is your personal Internet ArchiveThe 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
- [x] Initial command line client to add urls to a personal archive with Text, Html and Pdf copies of the website
- [x] Ability to save new versions of the same URL
- [ ] Version "diffing" and browsing
- [ ] User friendly interface (web, etc)
- [ ] Searching and other functions## Usage
```
Usage: stashboxWhere 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 -h
```## Contributing
New issues and pull requests are welcomed. Please see [CONTRIBUTING.md](CONTRIBUTING.md)
## Contributors
Made with [contributors-img](https://contributors-img.web.app).