{"id":13794154,"url":"https://github.com/textury/arkb","last_synced_at":"2025-05-12T20:31:34.473Z","repository":{"id":37173879,"uuid":"295883311","full_name":"textury/arkb","owner":"textury","description":"Upload your files to the Arweave network.","archived":false,"fork":false,"pushed_at":"2024-08-17T03:36:19.000Z","size":661,"stargazers_count":279,"open_issues_count":7,"forks_count":60,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-04-15T14:44:35.281Z","etag":null,"topics":["arweave","blockchain","cli","cli-tool"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/textury.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":"2020-09-16T00:41:57.000Z","updated_at":"2025-04-08T19:29:06.000Z","dependencies_parsed_at":"2024-01-21T02:44:54.554Z","dependency_job_id":"42e7a18b-04d7-4fa6-ab69-1092a324047a","html_url":"https://github.com/textury/arkb","commit_stats":{"total_commits":280,"total_committers":11,"mean_commits":"25.454545454545453","dds":0.3392857142857143,"last_synced_commit":"bbe19f348c07bd2663ccb6178d68a000dc6953f6"},"previous_names":[],"tags_count":70,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/textury%2Farkb","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/textury%2Farkb/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/textury%2Farkb/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/textury%2Farkb/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/textury","download_url":"https://codeload.github.com/textury/arkb/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253816763,"owners_count":21968878,"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":["arweave","blockchain","cli","cli-tool"],"created_at":"2024-08-03T23:00:36.539Z","updated_at":"2025-05-12T20:31:29.593Z","avatar_url":"https://github.com/textury.png","language":"TypeScript","readme":"# arkb\n\nArweave Deploy that saves you data costs.\n\n## Features\n\n- No file size limit.\n- No amount of files limit.\n- Doesn't upload files that you have already uploaded.\n\n## How to use\n\narkb runs using NodeJS and NPM. You must have both installed on your machine for it to work.\n\nInstall arkb:\n\n```\nyarn global add arkb # recommended\n```\n\nor\n\n```\nnpm install -g arkb\n```\n\n\u003e **Note:** The installation of arkb needs node \u003e=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.\n\nAnd run:\n\n```\narkb help\n```\n\n\u003e **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).\n\n```\n                    d8b        d8b\n                    ?88        ?88\n                     88b        88b\n d888b8b    88bd88b  888  d88'  888888b\nd8P' ?88    88P'  `  888bd8P'   88P `?8b\n88b  ,88b  d88      d88888b    d88,  d88\n`?88P'`88bd88'     d88' `?88b,d88'`?88P'\n\n\n\nUsage: arkb [options] [command]\n\nOptions                                 Description\n--auto-confirm                          Skips the confirm screen\n--concurrency -c \u003cnumber\u003e               Multi thread, default is 5\n--content-type \u003ccontent type\u003e           Set the files content type\n--debug                                 Display log messages\n--fee-multiplier -m \u003cnumber\u003e            Set the fee multiplier for all transactions\n--force -f                              Force a redeploy of all the files\n--gateway -g \u003chost_or_ip\u003e               Set the gateway hostname or ip address\n--help -h                               Show usage help for a command\n--license                               Specify the license of your upload with an spdx li\n--no-colors                             Print to terminal without fancy colors\n--tag-name \u003cname\u003e                       Set a tag name\n--tag-value \u003cvalue\u003e                     Set a tag value\n--timeout -t \u003cnumber\u003e                   Set the request timeout\n--bundle                                Locally bundle your files and deploy to Arweave\n--use-bundler \u003chost_or_ip\u003e              Use an ans104 bundler service\n--wallet -w \u003cwallet_path\u003e               Set the key file path\n\nCommands (alias)                        Description\nbalance (b)                             Get the current balance of your wallet\ndeploy (d) \u003cfolder_or_file\u003e             Deploy a directory or file\nfund-bundler \u003camount\u003e                   Fund your bundler account\nhelp (h)                                Show usage help for a command\nnetwork (n)                             Get the current network info\nstatus (s) \u003ctxid\u003e                       Check the status of a transaction ID\ntransfer \u003caddress\u003e \u003camount\u003e             Send funds to an Arweave wallet\nversion (v)                             Show the current arkb version number\nwallet-export (we)                      Exports a previously saved wallet\nwallet-forget (wf)                      Removes a previously saved wallet\nwallet-save (ws) \u003cwallet_path\u003e          Saves a wallet, removes the need of the --wallet option\nwithdraw-bundler \u003camount\u003e               Withdraw from your bundler balance\n```\n\n## Contributing\n\n1.  Create a fork\n2.  Create your feature branch: `git checkout -b my-feature`\n3.  Commit your changes: `git commit -am 'Add some feature'`\n4.  Push to the branch: `git push origin my-new-feature`\n5.  Submit a pull request 🚀\n","funding_links":[],"categories":["Tools ⚙️"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftextury%2Farkb","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftextury%2Farkb","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftextury%2Farkb/lists"}