arweave-archive-cli

A CLI tool to archive webpage and it's screenshot to Arweave.

• Installation
• Github Actions
• Usage
  • Setup
  • Archive
  • Archives
  • Backup
  • Github Actions for Archive
• Author
• 🤝 Contributing
• Show your support

Installation

npm install arweave-archive-cli -g

OR

yarn add global arweave-archive-cli

Run arweave-archive or aar in terminal for more information regarding how to use the CLI.

$ aar
Usage: arweave-archive [options] [command]

A CLI tool to archive webpage and it's screenshot to Arweave

Options:
  -v, --version            output the version number
  -h, --help               display help for command

Commands:
  setup <jwkPath>          setup Arweave JWK file path
  archive [options] <url>  archive url single page webpage and screenshot to Arweave
  archives [options]       display all your archives
  backup [options] <path>  backup archives information
  init-action              initialize archive github action
  help [command]           display help for command

Github Actions

1. arweave-archive-action: Archive single page html and screenshot of websites to Arweave.

• A demo project using arweave-archive-action to archive list of urls and save it to a JSON file: arweave-archive-cronjob

Usage

Setup Arweave JWK Path

Run the following command with a Arweave JWK file path.

aar setup "arweave-jwk.json"

Archive

Usage: arweave-archive archive [options] <url>

archive url single page webpage and screenshot to Arweave

Arguments:
  url                             url to archive

Options:
  -j, --jwk-path <jwkPath>        Arweave JWK file path
  -g, --gateway-url <gatewayUrl>  Arweave gateway URL (default: "https://arweave.net")
  -b, --bundler-url <bundlerUrl>  Bundler URL (default: "https://node2.bundlr.network")
  -h, --help                      display help for command

Run this command to save single page html and screenshot for the given url to Arweave.

aar archive https://arweave.org

Archives

To display all your archives:

aar archives

Backup

To backup all your archives to a file:

aar backup 'saved.json'

Github Actions for Archive

To add arweave archive github action to a git repo:

aar init-action

Author

👤 Pawan Paudel

• Github: @pawanpaudel93

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!

Copyright © 2023 Pawan Paudel.