ar-io/ARIO Deploy

Deploy static sites to Arweave and update ArNS records. Perfect for PR previews and production deployments.

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Activelast commit Jun 12, 2026
License
MIT

Pinned Snippet

workflow.ymlSHA-pinned
uses: ar-io/ar-io-deploy@adb027f069a18ff472d657826c620a4ca4f08176 # v1.0.0

tags can be moved; commit SHAs can't. why a SHA?

namedescriptionrequireddefault
deploy-keyUpload key (pays for the upload): Arweave JWK wallet (base64-encoded or JSON string), or raw private key for Ethereum/Polygon/KYVE/Solana signersyes
arns-keyArNS authority key: base58-encoded Solana secret key that controls the ArNS name and signs the record update. Separate from the upload key.yes
arns-nameThe ArNS name to update (e.g., "myapp" for myapp.turbo-gateway.com)yes
undernameThe undername to use. Use "@" for base name, or a custom value for undernames (e.g., "docs" for docs_myapp.turbo-gateway.com)no@
deploy-folderPath to the folder containing built static files to deployno./dist
deploy-filePath to a single file to deploy (alternative to deploy-folder)no
ttl-secondsTTL in seconds for the ANT record (60-86400)no3600
sig-typeSigner type for the upload key that pays for the upload (arweave, ethereum, polygon, kyve, solana).noarweave
clusterSolana cluster for ArNS updates (mainnet or devnet)nomainnet
rpc-urlOptional Solana RPC URL override for ArNS updatesno
on-demandEnable on-demand payment with specified token (ario or base-eth)no
max-token-amountMaximum token amount for on-demand payment (used with on-demand)no
uploaderCustom Turbo upload service base URL (defaults to the ArDrive production endpoint).no
previewEnable preview mode: auto-generates undername from PR number and posts a comment with the preview URLnofalse
auto-undernameAutomatically generate undername from PR number or branch name (use preview for full PR preview functionality)nofalse
github-tokenGitHub token for posting PR comments (required when preview is enabled)no
no-dedupeDisable deduplication (do not cache or reuse previous uploads). By default, ario-deploy caches your deployment log to prevent uploading duplicate (unchanged) files.nofalse
dedupe-cache-max-entriesMaximum number of entries to keep in the dedupe cache (LRU). Default is 10000.no
namedescription
tx-idThe Arweave transaction ID of the uploaded content
deployment-urlThe full URL where the deployment is accessible
undername-usedThe undername that was used for the deployment