permaweb/Permaweb Deploy
Deploy static sites to Arweave and optionally update Permaweb Names references.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Activelast commit Jul 1, 2026
- License
- MIT
Pinned Snippet
uses: permaweb/permaweb-deploy@aedf6546383d34841b25c4e0be6659e877df357f # permaweb-deploy@3.4.0tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| deploy-key | Arweave JWK wallet (base64-encoded or JSON string) for Arweave signer, or raw private key for upload-only signer flows | yes | — |
| name | The Permaweb Names namespace name to update | no | — |
| reference-id | Reference ID to update directly, bypassing namespace name lookup | no | — |
| names-namespace | Namespace root reference or manifest ID used to resolve name | no | — |
| names-gateway | Gateway used for names reference and namespace reads | no | https://arweave.net |
| names-graphql | GraphQL endpoint used for names reference discovery | no | — |
| deploy-folder | Path to the folder containing built static files to deploy | no | ./dist |
| deploy-file | Path to a single file to deploy (alternative to deploy-folder) | no | — |
| sig-type | Signer type for uploads (names updates currently require arweave) | no | arweave |
| uploader | Bundler service base URL. Legacy uploads default to https://up.arweave.net; for HyperBEAM, pass the node URL. | no | — |
| uploader-type | Bundler protocol to use: legacy or hyperbeam | no | legacy |
| hyperbeam-upload-path | HyperBEAM bundler route used when uploader-type is hyperbeam | no | /~bundler@1.0/item?codec-device=ans104@1.0 |
| hyperbeam-auto-fund | Automatically fund the HyperBEAM local ledger before upload | no | false |
| hyperbeam-fund-amount | Optional minimum HyperBEAM local ledger balance override, in token base units | no | — |
| hyperbeam-token-id | Hyperbalance token ID to fund when the node advertises multiple tokens | no | — |
| hyperbeam-ledger-id | Hyperbalance ledger ID to fund when the node advertises multiple ledgers | no | — |
| hyperbeam-ao-state-url | AO state endpoint used while waiting for HyperBEAM auto-fund transfer assignment | no | https://state.forward.computer |
| preview | Enable preview mode: auto-generates a namespace name from the PR number and posts a comment with the deployment URL | no | false |
| auto-name | Automatically generate the namespace name from PR number or branch name | no | false |
| github-token | GitHub token for posting PR comments (required when preview is enabled) | no | — |
| no-dedupe | Disable deduplication (do not cache or reuse previous uploads). By default, permaweb-deploy caches your deployment log to prevent uploading duplicate files. | no | false |
| dedupe-cache-max-entries | Maximum number of entries to keep in the dedupe cache (LRU). Default is 10000. | no | — |
Outputs
| name | description |
|---|---|
| tx-id | The Arweave transaction ID of the uploaded content |
| deployment-url | The immutable Arweave URL where the deployment is accessible |
| name-used | The Permaweb Names namespace name that was used for the deployment |
| reference-id | The Permaweb Names reference ID that was updated |