{"id":28185113,"url":"https://github.com/wabarc/rivet","last_synced_at":"2025-05-16T06:11:22.947Z","repository":{"id":39851951,"uuid":"442479791","full_name":"wabarc/rivet","owner":"wabarc","description":"A toolkit makes it easier to archive webpages to IPFS","archived":false,"fork":false,"pushed_at":"2023-07-31T19:48:50.000Z","size":155,"stargazers_count":12,"open_issues_count":8,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-05-10T22:02:48.055Z","etag":null,"topics":["archiving","ipfs","webpage"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wabarc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2021-12-28T13:57:10.000Z","updated_at":"2024-05-30T11:34:18.000Z","dependencies_parsed_at":"2024-01-05T20:46:57.416Z","dependency_job_id":"d5703ecf-6e47-4f1e-b741-c8c8d936268d","html_url":"https://github.com/wabarc/rivet","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wabarc%2Frivet","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wabarc%2Frivet/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wabarc%2Frivet/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wabarc%2Frivet/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wabarc","download_url":"https://codeload.github.com/wabarc/rivet/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254478189,"owners_count":22077677,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["archiving","ipfs","webpage"],"created_at":"2025-05-16T06:11:20.687Z","updated_at":"2025-05-16T06:11:22.934Z","avatar_url":"https://github.com/wabarc.png","language":"Go","funding_links":[],"categories":["Tools"],"sub_categories":[],"readme":"# Rivet\n\n[![LICENSE](https://img.shields.io/github/license/wabarc/rivet.svg?color=green)](https://github.com/wabarc/rivet/blob/main/LICENSE)\n[![Go Report Card](https://goreportcard.com/badge/github.com/wabarc/rivet)](https://goreportcard.com/report/github.com/wabarc/rivet)\n[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/wabarc/rivet/Builder?color=brightgreen)](https://github.com/wabarc/rivet/actions/workflows/builder.yml)\n[![Go Reference](https://img.shields.io/badge/godoc-reference-blue.svg)](https://pkg.go.dev/github.com/wabarc/rivet)\n[![Releases](https://img.shields.io/github/v/release/wabarc/rivet.svg?include_prereleases\u0026color=blue)](https://github.com/wabarc/rivet/releases)\n\nRivet is both a command-line tool and a Golang package for archiving webpages to IPFS.\n\nSupported Golang version: See [.github/workflows/testing.yml](./.github/workflows/testing.yml)\n\n## Installation\n\nThe simplest, cross-platform way is to download from [GitHub Releases](https://github.com/wabarc/rivet/releases) and place the executable file in your PATH.\n\nFrom source:\n\n```sh\ngo get -u github.com/wabarc/rivet/cmd/rivet\n```\n\nFrom GitHub Releases:\n\n```sh\nsh \u003c(wget https://github.com/wabarc/rivet/raw/main/install.sh -O-)\n```\n\nUsing [Snapcraft](https://snapcraft.io/rivet) (on GNU/Linux)\n\n```sh\nsudo snap install rivet\n```\n\n## Usage\n\n### Command line\n\n```sh\nA toolkit makes it easier to archive webpages to IPFS.\n\nUsage:\n\n  rivet [options] [url1] ... [urlN]\n\n  -host string\n        IPFS node address (default \"localhost\")\n  -m string\n        Pin mode, supports mode: local, remote, archive (default \"remote\")\n  -p string\n        Pinner sceret or password.\n  -port int\n        IPFS node port (default 5001)\n  -t string\n        IPFS pinner, supports pinners: infura, pinata, nftstorage, web3storage. (default \"infura\")\n  -timeout uint\n        Timeout for every input URL (default 30)\n  -u string\n        Pinner apikey or username.\n```\n\n#### Examples\n\nStores data on local IPFS node.\n\n```sh\nrivet -m local https://example.com https://example.org\n```\n\nStores data to remote pinning services.\n\n```sh\nrivet https://example.com\n```\n\nOr, specify a pinning service.\n\n```sh\nrivet -t pinata -k your-apikey -s your-secret https://example.com\n```\n\nOr, stores file locally without any IPFS node.\n\n```sh\nrivet -m archive https://example.com\n```\n\n### Go package\n\n\u003c!-- markdownlint-disable MD010 --\u003e\n```go\npackage main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"net/url\"\n\n\t\"github.com/wabarc/ipfs-pinner\"\n\t\"github.com/wabarc/rivet\"\n\t\"github.com/wabarc/rivet/ipfs\"\n)\n\nfunc main() {\n\topts := []ipfs.PinningOption{\n\t\tipfs.Mode(ipfs.Remote),\n\t\tipfs.Uses(pinner.Infura),\n\t}\n\tp := ipfs.Options(opts...)\n\tr := \u0026rivet.Shaft{Hold: p}\n\tl := \"https://example.com\"\n\tinput, err := url.Parse(l)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\n\tdst, err := r.Wayback(context.TODO(), input)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\tfmt.Println(dst)\n}\n```\n\u003c!-- markdownlint-enable MD010 --\u003e\n\n## F.A.Q\n\n### Optional to disable JavaScript for some URI?\n\nIf you prefer to disable JavaScript on saving webpage, you could add environmental variables `DISABLEJS_URIS`\nand set the values with the following formats:\n\n```sh\nexport DISABLEJS_URIS=wikipedia.org|eff.org/tags\n```\n\nIt will disable JavaScript for domain of the `wikipedia.org` and path of the `eff.org/tags` if matching it.\n\n## Credit\n\nSpecial thanks to [@RadhiFadlillah](https://github.com/RadhiFadlillah) for making [obelisk](https://github.com/go-shiori/obelisk), under which the crawling of the web is based.\n\n## Contributing\n\nWe encourage all contributions to this repository! Open an issue! Or open a Pull Request!\n\n## License\n\nThis software is released under the terms of the MIT. See the [LICENSE](https://github.com/wabarc/rivet/blob/main/LICENSE) file for details.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwabarc%2Frivet","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwabarc%2Frivet","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwabarc%2Frivet/lists"}