Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/textury/arkb
Upload your files to the Arweave network.
https://github.com/textury/arkb
arweave blockchain cli cli-tool
Last synced: 3 months ago
JSON representation
Upload your files to the Arweave network.
- Host: GitHub
- URL: https://github.com/textury/arkb
- Owner: textury
- License: mit
- Created: 2020-09-16T00:41:57.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-09-14T20:15:27.000Z (about 1 year ago)
- Last Synced: 2024-07-06T17:08:01.078Z (4 months ago)
- Topics: arweave, blockchain, cli, cli-tool
- Language: TypeScript
- Homepage:
- Size: 646 KB
- Stars: 267
- Watchers: 7
- Forks: 60
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-arweave - arkb - Deploy your files to the Arweave network. (Tools ⚙️)
README
# arkb
Arweave Deploy that saves you data costs.
## Features
- No file size limit.
- No amount of files limit.
- Doesn't upload files that you have already uploaded.
## How to use
arkb runs using NodeJS and NPM. You must have both installed on your machine for it to work.
Install arkb:
```
yarn global add arkb # recommended
```
or
```
npm install -g arkb
```
> **Note:** The installation of arkb needs node >=15.11.0 or you will get an error when using `arkb`. To manage multiple active nodejs, we recommend you have [nvm](https://github.com/nvm-sh/nvm) installed on your computer, then you can switch different node in a simple command.
And run:
```
arkb help
```
> **Note:** If you are planning to upload large batches of data transactions to the Arweave network, it is _strongly_ advised that you use the `--use-bundler` option instead of regular deploy to avoid transaction failures. You can read about bundles and their advantages on the [Arwiki](https://arwiki.wiki/#/en/preview/WUAtjfiDQEIqhsUcHXIFTn5ZmeDIE7If9hJREBLRgak).
```
d8b d8b
?88 ?88
88b 88b
d888b8b 88bd88b 888 d88' 888888b
d8P' ?88 88P' ` 888bd8P' 88P `?8b
88b ,88b d88 d88888b d88, d88
`?88P'`88bd88' d88' `?88b,d88'`?88P'
Usage: arkb [options] [command]
Options Description
--auto-confirm Skips the confirm screen
--concurrency -c Multi thread, default is 5
--content-type Set the files content type
--debug Display log messages
--fee-multiplier -m Set the fee multiplier for all transactions
--force -f Force a redeploy of all the files
--gateway -g Set the gateway hostname or ip address
--help -h Show usage help for a command
--license Specify the license of your upload with an spdx li
--no-colors Print to terminal without fancy colors
--tag-name Set a tag name
--tag-value Set a tag value
--timeout -t Set the request timeout
--bundle Locally bundle your files and deploy to Arweave
--use-bundler Use an ans104 bundler service
--wallet -w Set the key file path
Commands (alias) Description
balance (b) Get the current balance of your wallet
deploy (d) Deploy a directory or file
fund-bundler Fund your bundler account
help (h) Show usage help for a command
network (n) Get the current network info
status (s) Check the status of a transaction ID
transfer
Send funds to an Arweave wallet
version (v) Show the current arkb version number
wallet-export (we) Exports a previously saved wallet
wallet-forget (wf) Removes a previously saved wallet
wallet-save (ws) Saves a wallet, removes the need of the --wallet option
withdraw-bundler Withdraw from your bundler balance
```
## Contributing
1. Create a fork
2. Create your feature branch: `git checkout -b my-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request 🚀