permaweb-deploy 0.0.0-rc-20251001215907

package/README.md

@@ -0,0 +1,332 @@
+# Permaweb Deploy
+
+Inspired by the [cookbook github action deployment guide](https://cookbook.arweave.dev/guides/deployment/github-action.html), `permaweb-deploy` is a Node.js command-line tool designed to streamline the deployment of web applications to the permaweb using Arweave. It uploads your build folder or a single file, creates Arweave manifests, and updates ArNS (Arweave Name Service) records via ANT (Arweave Name Token) with the transaction ID.
+
+## Features
+
+- **Turbo SDK Integration:** Uses Turbo SDK for fast, reliable file uploads to Arweave
+- **Arweave Manifest v0.2.0:** Creates manifests with fallback support for SPAs
+- **ArNS Updates:** Updates ArNS records via ANT with new transaction IDs and metadata
+- **Automated Workflow:** Integrates with GitHub Actions for continuous deployment
+- **Git Hash Tagging:** Automatically tags deployments with Git commit hashes
+- **404 Fallback Detection:** Automatically detects and sets 404.html as fallback
+- **Network Support:** Supports mainnet, testnet, and custom ARIO process IDs
+- **Flexible Deployment:** Supports deploying a folder or a single file
+- **Modern CLI:** Built with oclif for a robust command-line experience
+- **TypeScript:** Fully typed for better developer experience
+
+## Installation
+
+Install the package using pnpm (recommended):
+
+```bash
+pnpm add -D permaweb-deploy
+```
+
+Or with npm:
+
+```bash
+npm install --save-dev permaweb-deploy
+```
+
+Or with yarn:
+
+```bash
+yarn add --dev permaweb-deploy
+```
+
+## Prerequisites
+
+1. **For Arweave signer (default):** Encode your Arweave wallet key in base64 format and set it as a GitHub secret:
+
+   ```bash
+   base64 -i wallet.json | pbcopy
+   ```
+
+2. **For Ethereum/Polygon/KYVE signers:** Use your raw private key (no encoding needed) as the `DEPLOY_KEY`.
+
+3. Ensure that the secret name for the encoded wallet or private key is `DEPLOY_KEY`.
+
+⚠️ **Important:** Use a dedicated wallet for deployments to minimize security risks. Ensure your wallet has sufficient Turbo Credits for uploads.
+
+## Usage
+
+### Interactive Mode (Easiest)
+
+**Command Menu:**
+
+Simply run the CLI for an interactive command selector:
+
+```bash
+permaweb-deploy
+# or explicitly
+permaweb-deploy interactive
+```
+
+This shows a menu with options:
+- **Deploy to Permaweb** - Start the deployment wizard
+- **Show Help** - Display help information
+- **Exit** - Exit the CLI
+
+**Interactive Deploy (Guided):**
+
+Run the deploy command without arguments to be guided through all deployment options:
+
+```bash
+permaweb-deploy deploy
+```
+
+This will prompt you for:
+- ArNS name
+- Wallet method (file, string, or environment variable)
+- Signer type (Arweave, Ethereum, Polygon, KYVE)
+- What to deploy (folder or file)
+- Advanced options (optional: undername, TTL, network)
+
+### Direct Commands
+
+Use flags for faster, scriptable deployments:
+
+```bash
+# Basic deployment with wallet file
+permaweb-deploy deploy --arns-name my-app --wallet ./wallet.json
+```
+
+Deploy using private key directly:
+
+```bash
+permaweb-deploy deploy --arns-name my-app --private-key "$(cat wallet.json)"
+```
+
+Deploy using environment variable:
+
+```bash
+DEPLOY_KEY=$(base64 -i wallet.json) permaweb-deploy deploy --arns-name my-app
+```
+
+Deploy a specific folder:
+
+```bash
+permaweb-deploy deploy --arns-name my-app --wallet ./wallet.json --deploy-folder ./build
+```
+
+Deploy a single file:
+
+```bash
+permaweb-deploy deploy --arns-name my-app --wallet ./wallet.json --deploy-file ./path/to/file.txt
+```
+
+### Advanced Usage
+
+Deploy to an undername (subdomain):
+
+```bash
+permaweb-deploy deploy --arns-name my-app --wallet ./wallet.json --undername staging
+```
+
+Deploy with a custom TTL:
+
+```bash
+permaweb-deploy deploy --arns-name my-app --wallet ./wallet.json --ttl-seconds 7200
+```
+
+Deploy using Ethereum wallet (file):
+
+```bash
+permaweb-deploy deploy --arns-name my-app --sig-type ethereum --wallet ./private-key.txt
+```
+
+Deploy using Ethereum wallet (direct key):
+
+```bash
+permaweb-deploy deploy --arns-name my-app --sig-type ethereum --private-key "0x1234..."
+```
+
+### Command Options
+
+- `--arns-name, -n` (required): The ArNS name to update
+- `--ario-process, -p`: ARIO process to use (`mainnet`, `testnet`, or a custom process ID). Default: `mainnet`
+- `--deploy-folder, -d`: Folder to deploy. Default: `./dist`
+- `--deploy-file, -f`: Deploy a single file instead of a folder
+- `--undername, -u`: ANT undername to update. Default: `@`
+- `--ttl-seconds, -t`: TTL in seconds for the ANT record (60-86400). Default: `60`
+- `--sig-type, -s`: Signer type for deployment. Choices: `arweave`, `ethereum`, `polygon`, `kyve`. Default: `arweave`
+- `--wallet, -w`: Path to wallet file (JWK for Arweave, private key for Ethereum/Polygon/KYVE)
+- `--private-key, -k`: Private key or JWK JSON string (alternative to `--wallet`)
+
+### Package.json Scripts
+
+Add deployment scripts to your `package.json`:
+
+```json
+{
+  "scripts": {
+    "build": "vite build",
+    "deploy": "pnpm build && permaweb-deploy deploy --arns-name <ARNS_NAME>",
+    "deploy:staging": "pnpm build && permaweb-deploy deploy --arns-name <ARNS_NAME> --undername staging",
+    "deploy:testnet": "pnpm build && permaweb-deploy deploy --arns-name <ARNS_NAME> --ario-process testnet"
+  }
+}
+```
+
+Then deploy with:
+
+```bash
+DEPLOY_KEY=$(base64 -i wallet.json) pnpm deploy
+```
+
+## GitHub Actions Workflow
+
+To automate deployments, set up a GitHub Actions workflow:
+
+```yaml
+name: Deploy to Permaweb
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      
+      - uses: pnpm/action-setup@v3
+        with:
+          version: 9
+      
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: 'pnpm'
+      
+      - run: pnpm install
+      
+      - run: pnpm deploy
+        env:
+          DEPLOY_KEY: ${{ secrets.DEPLOY_KEY }}
+```
+
+## Development
+
+### Setup
+
+```bash
+# Install dependencies
+pnpm install
+
+# Build the project
+pnpm build
+
+# Run in development mode
+pnpm dev
+
+# Run tests
+pnpm test
+
+# Run linter
+pnpm lint
+
+# Format code
+pnpm format
+```
+
+### Project Structure
+
+```
+permaweb-deploy/
+├── src/
+│   ├── commands/        # oclif commands
+│   │   └── deploy.ts
+│   ├── types/           # TypeScript type definitions
+│   │   └── index.ts
+│   ├── utils/           # Utility functions
+│   │   ├── constants.ts
+│   │   ├── signer.ts
+│   │   ├── uploader.ts
+│   │   └── __tests__/   # Unit tests
+│   └── index.ts         # Main entry point
+├── bin/                 # Executable scripts
+│   ├── run.js
+│   └── dev.js
+├── .changeset/          # Changesets configuration
+├── .husky/              # Git hooks
+└── dist/                # Build output
+```
+
+## Security & Best Practices
+
+- **Dedicated Wallet:** Always use a dedicated wallet for deployments to minimize security risks
+- **Wallet Encoding:** Arweave wallets must be base64 encoded to be used in the deployment script
+- **ArNS Name:** The ArNS Name must be passed so that the ANT Process can be resolved to update the target undername or root record
+- **Turbo Credits:** Ensure your wallet has sufficient Turbo Credits before deployment
+- **Secret Management:** Keep your `DEPLOY_KEY` secret secure and never commit it to your repository
+- **Build Security:** Always check your build for exposed environmental secrets before deployment, as data on Arweave is permanent
+
+## Troubleshooting
+
+- **Error: "DEPLOY_KEY environment variable not set":** Verify your base64 encoded wallet is set as the `DEPLOY_KEY` environment variable
+- **Error: "deploy-folder does not exist":** Check that your build folder exists and the path is correct
+- **Error: "deploy-file does not exist":** Check that your build file exists and the path is correct
+- **Error: "ArNS name does not exist":** Verify the ArNS name is correct and exists in the specified network
+- **Upload timeouts:** Files have a timeout for upload. Large files may fail and require optimization
+- **Insufficient Turbo Credits:** Ensure your wallet has enough Turbo Credits for the deployment
+
+## Contributing
+
+Contributions are welcome! Please follow these guidelines:
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Run tests and linter: `pnpm test && pnpm lint`
+5. Create a changeset: `pnpm changeset`
+6. Commit your changes using conventional commits
+7. Push and create a pull request
+
+### Conventional Commits
+
+This project uses [Conventional Commits](https://www.conventionalcommits.org/). Commit messages should follow this format:
+
+```
+type(scope): subject
+
+body (optional)
+```
+
+Types: `feat`, `fix`, `docs`, `style`, `refactor`, `perf`, `test`, `build`, `ci`, `chore`, `revert`
+
+### Changesets
+
+We use [changesets](https://github.com/changesets/changesets) for version management. When making changes:
+
+```bash
+pnpm changeset
+```
+
+Follow the prompts to describe your changes.
+
+## Dependencies
+
+- **@ar.io/sdk** - For ANT operations and ArNS management
+- **@ardrive/turbo-sdk** - For fast file uploads to Arweave
+- **@permaweb/aoconnect** - For AO network connectivity
+- **@oclif/core** - CLI framework
+- **mime-types** - MIME type detection
+
+## License
+
+ISC
+
+## Author
+
+NickJ202
+
+## Links
+
+- [GitHub Repository](https://github.com/permaweb/permaweb-deploy)
+- [Issues](https://github.com/permaweb/permaweb-deploy/issues)
+- [Arweave Documentation](https://docs.arweave.org/)
+- [AR.IO Documentation](https://docs.ar.io/)

package/bin/dev.js

@@ -0,0 +1,6 @@
+#!/usr/bin/env tsx
+
+import { execute } from '@oclif/core'
+
+await execute({ development: true, dir: import.meta.url })
+

package/bin/run.js

@@ -0,0 +1,6 @@
+#!/usr/bin/env node
+
+import { execute } from '@oclif/core'
+
+await execute({ development: false, dir: import.meta.url })
+

package/dist/index.js

@@ -0,0 +1,299 @@
+#!/usr/bin/env node
+"use strict";
+
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+var _turboSdk = require("@ardrive/turbo-sdk");
+var _fs = _interopRequireDefault(require("fs"));
+var _yargs = _interopRequireDefault(require("yargs"));
+var _helpers = require("yargs/helpers");
+var _mimeTypes = _interopRequireDefault(require("mime-types"));
+var _sdk = require("@ar.io/sdk");
+var _aoconnect = require("@permaweb/aoconnect");
+var _nodeStream = require("node:stream");
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
+function _regenerator() { /*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/babel/babel/blob/main/packages/babel-helpers/LICENSE */ var e, t, r = "function" == typeof Symbol ? Symbol : {}, n = r.iterator || "@@iterator", o = r.toStringTag || "@@toStringTag"; function i(r, n, o, i) { var c = n && n.prototype instanceof Generator ? n : Generator, u = Object.create(c.prototype); return _regeneratorDefine2(u, "_invoke", function (r, n, o) { var i, c, u, f = 0, p = o || [], y = !1, G = { p: 0, n: 0, v: e, a: d, f: d.bind(e, 4), d: function d(t, r) { return i = t, c = 0, u = e, G.n = r, a; } }; function d(r, n) { for (c = r, u = n, t = 0; !y && f && !o && t < p.length; t++) { var o, i = p[t], d = G.p, l = i[2]; r > 3 ? (o = l === n) && (u = i[(c = i[4]) ? 5 : (c = 3, 3)], i[4] = i[5] = e) : i[0] <= d && ((o = r < 2 && d < i[1]) ? (c = 0, G.v = n, G.n = i[1]) : d < l && (o = r < 3 || i[0] > n || n > l) && (i[4] = r, i[5] = n, G.n = l, c = 0)); } if (o || r > 1) return a; throw y = !0, n; } return function (o, p, l) { if (f > 1) throw TypeError("Generator is already running"); for (y && 1 === p && d(p, l), c = p, u = l; (t = c < 2 ? e : u) || !y;) { i || (c ? c < 3 ? (c > 1 && (G.n = -1), d(c, u)) : G.n = u : G.v = u); try { if (f = 2, i) { if (c || (o = "next"), t = i[o]) { if (!(t = t.call(i, u))) throw TypeError("iterator result is not an object"); if (!t.done) return t; u = t.value, c < 2 && (c = 0); } else 1 === c && (t = i["return"]) && t.call(i), c < 2 && (u = TypeError("The iterator does not provide a '" + o + "' method"), c = 1); i = e; } else if ((t = (y = G.n < 0) ? u : r.call(n, G)) !== a) break; } catch (t) { i = e, c = 1, u = t; } finally { f = 1; } } return { value: t, done: y }; }; }(r, o, i), !0), u; } var a = {}; function Generator() {} function GeneratorFunction() {} function GeneratorFunctionPrototype() {} t = Object.getPrototypeOf; var c = [][n] ? t(t([][n]())) : (_regeneratorDefine2(t = {}, n, function () { return this; }), t), u = GeneratorFunctionPrototype.prototype = Generator.prototype = Object.create(c); function f(e) { return Object.setPrototypeOf ? Object.setPrototypeOf(e, GeneratorFunctionPrototype) : (e.__proto__ = GeneratorFunctionPrototype, _regeneratorDefine2(e, o, "GeneratorFunction")), e.prototype = Object.create(u), e; } return GeneratorFunction.prototype = GeneratorFunctionPrototype, _regeneratorDefine2(u, "constructor", GeneratorFunctionPrototype), _regeneratorDefine2(GeneratorFunctionPrototype, "constructor", GeneratorFunction), GeneratorFunction.displayName = "GeneratorFunction", _regeneratorDefine2(GeneratorFunctionPrototype, o, "GeneratorFunction"), _regeneratorDefine2(u), _regeneratorDefine2(u, o, "Generator"), _regeneratorDefine2(u, n, function () { return this; }), _regeneratorDefine2(u, "toString", function () { return "[object Generator]"; }), (_regenerator = function _regenerator() { return { w: i, m: f }; })(); }
+function _regeneratorDefine2(e, r, n, t) { var i = Object.defineProperty; try { i({}, "", {}); } catch (e) { i = 0; } _regeneratorDefine2 = function _regeneratorDefine(e, r, n, t) { if (r) i ? i(e, r, { value: n, enumerable: !t, configurable: !t, writable: !t }) : e[r] = n;else { var o = function o(r, n) { _regeneratorDefine2(e, r, function (e) { return this._invoke(r, n, e); }); }; o("next", 0), o("throw", 1), o("return", 2); } }, _regeneratorDefine2(e, r, n, t); }
+function _toConsumableArray(r) { return _arrayWithoutHoles(r) || _iterableToArray(r) || _unsupportedIterableToArray(r) || _nonIterableSpread(); }
+function _nonIterableSpread() { throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+function _iterableToArray(r) { if ("undefined" != typeof Symbol && null != r[Symbol.iterator] || null != r["@@iterator"]) return Array.from(r); }
+function _arrayWithoutHoles(r) { if (Array.isArray(r)) return _arrayLikeToArray(r); }
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+function _slicedToArray(r, e) { return _arrayWithHoles(r) || _iterableToArrayLimit(r, e) || _unsupportedIterableToArray(r, e) || _nonIterableRest(); }
+function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
+function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
+function _iterableToArrayLimit(r, l) { var t = null == r ? null : "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (null != t) { var e, n, i, u, a = [], f = !0, o = !1; try { if (i = (t = t.call(r)).next, 0 === l) { if (Object(t) !== t) return; f = !1; } else for (; !(f = (e = i.call(t)).done) && (a.push(e.value), a.length !== l); f = !0); } catch (r) { o = !0, n = r; } finally { try { if (!f && null != t["return"] && (u = t["return"](), Object(u) !== u)) return; } finally { if (o) throw n; } } return a; } }
+function _arrayWithHoles(r) { if (Array.isArray(r)) return r; }
+function asyncGeneratorStep(n, t, e, r, o, a, c) { try { var i = n[a](c), u = i.value; } catch (n) { return void e(n); } i.done ? t(u) : Promise.resolve(u).then(r, o); }
+function _asyncToGenerator(n) { return function () { var t = this, e = arguments; return new Promise(function (r, o) { var a = n.apply(t, e); function _next(n) { asyncGeneratorStep(a, r, o, _next, _throw, "next", n); } function _throw(n) { asyncGeneratorStep(a, r, o, _next, _throw, "throw", n); } _next(void 0); }); }; }
+var arweaveTxIdRegex = /^[a-zA-Z0-9-_]{43}$/;
+var argv = (0, _yargs["default"])((0, _helpers.hideBin)(process.argv)).version('2.1.0').help().usage('Usage: $0 --arns-name <name> [options]').example('$0 --arns-name my-app', 'Deploy to my-app.arweave.dev').example('$0 --arns-name my-app --undername staging', 'Deploy to staging.my-app.arweave.dev').option('ario-process', {
+  alias: 'p',
+  type: 'string',
+  description: 'The ARIO process to use',
+  demandOption: true,
+  "default": _sdk.ARIO_MAINNET_PROCESS_ID
+}).option('arns-name', {
+  alias: 'n',
+  type: 'string',
+  description: 'The ARNS name',
+  demandOption: true
+}).option('deploy-folder', {
+  alias: 'd',
+  type: 'string',
+  description: 'Folder to deploy.',
+  "default": './dist'
+}).option('deploy-file', {
+  alias: 'f',
+  type: 'string',
+  description: 'File to deploy.'
+}).option('ttl-seconds', {
+  alias: 't',
+  type: 'number',
+  description: 'ArNS TTL Seconds',
+  "default": 60
+}).option('undername', {
+  alias: 'u',
+  type: 'string',
+  description: 'ANT undername to update.',
+  "default": '@'
+}).option('sig-type', {
+  alias: 's',
+  type: 'string',
+  description: 'The type of signer to be used for deployment.',
+  choices: ['arweave', 'ethereum', 'polygon',
+  // 'solana',
+  'kyve'],
+  "default": 'arweave'
+}).check(function (argv) {
+  if (argv.ttl < 60 || argv.ttl > 86400) {
+    throw new Error('TTL must be between 60 seconds (1 minute) and 86400 seconds (1 day)');
+  }
+  return true;
+}).argv;
+var DEPLOY_KEY = process.env.DEPLOY_KEY;
+var ARNS_NAME = argv['arns-name'];
+var ARIO_PROCESS = argv['ario-process'];
+var TTL_SECONDS = argv['ttl-seconds'];
+if (ARIO_PROCESS === 'mainnet') {
+  ARIO_PROCESS = _sdk.ARIO_MAINNET_PROCESS_ID;
+} else if (ARIO_PROCESS === 'testnet') {
+  ARIO_PROCESS = _sdk.ARIO_TESTNET_PROCESS_ID;
+}
+_asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee() {
+  var ario, arnsNameRecord, signer, token, jwk, turbo, uploadResult, txOrManifestId, mimeType, origPaths, newPaths, replaceManifest, _i, _Object$entries, _Object$entries$_i, key, value, newKey, newManifest, buffer, _yield$turbo$uploadFi, id, ant, _t, _t2;
+  return _regenerator().w(function (_context) {
+    while (1) switch (_context.n) {
+      case 0:
+        if (!ARIO_PROCESS || !arweaveTxIdRegex.test(ARIO_PROCESS)) {
+          console.error('ARIO_PROCESS must be a valid Arweave transaction ID, or "mainnet" or "testnet"');
+          process.exit(1);
+        }
+        if (!DEPLOY_KEY) {
+          console.error('DEPLOY_KEY not configured');
+          process.exit(1);
+        }
+        if (!ARNS_NAME) {
+          console.error('ARNS_NAME not configured');
+          process.exit(1);
+        }
+        if (!Number.isFinite(TTL_SECONDS) || TTL_SECONDS < 60 || TTL_SECONDS > 86400) {
+          console.error('TTL_SECONDS must be a number between 60 and 86400 seconds');
+          process.exit(1);
+        }
+        if (argv.deployFile && !_fs["default"].existsSync(argv.deployFile)) {
+          console.error("deploy-file [".concat(argv.deployFolder, "] does not exist"));
+          process.exit(1);
+        } else {
+          if (!_fs["default"].existsSync(argv.deployFolder)) {
+            console.error("deploy-folder [".concat(argv.deployFolder, "] does not exist"));
+            process.exit(1);
+          }
+        }
+        if (argv.undername.length === 0) {
+          console.error('undername must be set');
+          process.exit(1);
+        }
+        ario = _sdk.ARIO.init({
+          process: new _sdk.AOProcess({
+            processId: ARIO_PROCESS,
+            ao: (0, _aoconnect.connect)({
+              MODE: 'legacy',
+              CU_URL: 'https://cu.ardrive.io'
+            })
+          })
+        });
+        _context.n = 1;
+        return ario.getArNSRecord({
+          name: ARNS_NAME
+        })["catch"](function (e) {
+          console.error("ARNS name [".concat(ARNS_NAME, "] does not exist"));
+          process.exit(1);
+        });
+      case 1:
+        arnsNameRecord = _context.v;
+        _context.p = 2;
+        _t = argv['sig-type'];
+        _context.n = _t === 'ethereum' ? 3 : _t === 'polygon' ? 4 : _t === 'arweave' ? 5 : _t === 'kyve' ? 6 : 7;
+        break;
+      case 3:
+        signer = new _turboSdk.EthereumSigner(DEPLOY_KEY);
+        token = 'ethereum';
+        return _context.a(3, 8);
+      case 4:
+        signer = new _turboSdk.EthereumSigner(DEPLOY_KEY);
+        token = 'pol';
+        return _context.a(3, 8);
+      case 5:
+        jwk = JSON.parse(Buffer.from(DEPLOY_KEY, 'base64').toString('utf-8'));
+        signer = new _sdk.ArweaveSigner(jwk);
+        token = 'arweave';
+        return _context.a(3, 8);
+      case 6:
+        signer = new _turboSdk.EthereumSigner(DEPLOY_KEY);
+        token = 'kyve';
+        return _context.a(3, 8);
+      case 7:
+        throw new Error("Invalid sig-type provided: ".concat(argv['sig-type'], ". Allowed values are 'arweave', 'ethereum', 'polygon', or 'kyve'."));
+      case 8:
+        turbo = _turboSdk.TurboFactory.authenticated({
+          signer: signer,
+          token: token
+        });
+        if (!argv['deploy-file']) {
+          _context.n = 10;
+          break;
+        }
+        // Detect MIME type for the file
+        mimeType = _mimeTypes["default"].lookup(argv['deploy-file']) || 'application/octet-stream';
+        _context.n = 9;
+        return turbo.uploadFile({
+          file: argv['deploy-file'],
+          dataItemOpts: {
+            tags: [{
+              name: 'App-Name',
+              value: 'Permaweb-Deploy'
+            },
+            // prevents identical transaction Ids from eth wallets
+            {
+              name: 'anchor',
+              value: new Date().toISOString()
+            }, {
+              name: 'Content-Type',
+              value: mimeType
+            }]
+          }
+        });
+      case 9:
+        uploadResult = _context.v;
+        txOrManifestId = uploadResult.id;
+        _context.n = 13;
+        break;
+      case 10:
+        _context.n = 11;
+        return turbo.uploadFolder({
+          folderPath: argv['deploy-folder'],
+          dataItemOpts: {
+            tags: [{
+              name: 'App-Name',
+              value: 'Permaweb-Deploy'
+            },
+            // prevents identical transaction Ids from eth wallets
+            {
+              name: 'anchor',
+              value: new Date().toISOString()
+            }]
+          }
+        });
+      case 11:
+        uploadResult = _context.v;
+        txOrManifestId = uploadResult.manifestResponse.id; //might replace now
+
+        // Make default folder paths work by adding extra path entries
+        origPaths = uploadResult.manifest.paths;
+        newPaths = {};
+        replaceManifest = false;
+        for (_i = 0, _Object$entries = Object.entries(origPaths); _i < _Object$entries.length; _i++) {
+          _Object$entries$_i = _slicedToArray(_Object$entries[_i], 2), key = _Object$entries$_i[0], value = _Object$entries$_i[1];
+          newPaths[key] = value;
+          if (key.endsWith('/index.html')) {
+            newKey = key.replace(/\/index\.html$/, '');
+            newPaths[newKey] = value;
+            replaceManifest = true;
+          }
+          ;
+        }
+        ;
+        if (!replaceManifest) {
+          _context.n = 13;
+          break;
+        }
+        console.info('replacing manifest');
+        newManifest = _objectSpread(_objectSpread({}, uploadResult.manifest), {}, {
+          paths: newPaths
+        });
+        buffer = Buffer.from(JSON.stringify(newManifest));
+        _context.n = 12;
+        return turbo.uploadFile({
+          fileStreamFactory: function fileStreamFactory() {
+            return _nodeStream.Readable.from(buffer);
+          },
+          fileSizeFactory: function fileSizeFactory() {
+            return buffer.length;
+          },
+          dataItemOpts: {
+            tags: [{
+              name: 'Content-Type',
+              value: 'application/x.arweave-manifest+json'
+            }]
+          }
+        });
+      case 12:
+        _yield$turbo$uploadFi = _context.v;
+        id = _yield$turbo$uploadFi.id;
+        txOrManifestId = id;
+      case 13:
+        console.log('-------------------- DEPLOY DETAILS --------------------');
+        console.log("Tx ID: ".concat(txOrManifestId));
+        console.log("ArNS Name: ".concat(ARNS_NAME));
+        console.log("Undername: ".concat(argv.undername));
+        console.log("ANT: ".concat(arnsNameRecord.processId));
+        console.log("AR IO Process: ".concat(ARIO_PROCESS));
+        console.log("TTL Seconds: ".concat(TTL_SECONDS));
+        console.log('--------------------------------------------------------');
+        ant = _sdk.ANT.init({
+          processId: arnsNameRecord.processId,
+          signer: signer
+        }); // Update the ANT record (assumes the JWK is a controller or owner)
+        _context.n = 14;
+        return ant.setRecord({
+          undername: argv.undername,
+          transactionId: txOrManifestId,
+          ttlSeconds: argv['ttl-seconds']
+        }, {
+          tags: [{
+            name: 'App-Name',
+            value: 'Permaweb-Deploy'
+          }].concat(_toConsumableArray(process.env.GITHUB_SHA ? [{
+            name: 'GIT-HASH',
+            value: process.env.GITHUB_SHA
+          }] : []))
+        });
+      case 14:
+        console.log("Deployed TxId [".concat(txOrManifestId, "] to name [").concat(ARNS_NAME, "] for ANT [").concat(arnsNameRecord.processId, "] using undername [").concat(argv.undername, "]"));
+        _context.n = 16;
+        break;
+      case 15:
+        _context.p = 15;
+        _t2 = _context.v;
+        console.error('Deployment failed:', _t2);
+        process.exit(1); // Exit with error code
+      case 16:
+        return _context.a(2);
+    }
+  }, _callee, null, [[2, 15]]);
+}))();

package/package.json

@@ -0,0 +1,96 @@
+{
+  "name": "permaweb-deploy",
+  "version": "0.0.0-rc-20251001215907",
+  "description": "Permaweb App Deployment Package",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "type": "module",
+  "bin": {
+    "permaweb-deploy": "./bin/run.js"
+  },
+  "oclif": {
+    "bin": "permaweb-deploy",
+    "dirname": "permaweb-deploy",
+    "commands": "./dist/commands",
+    "topicSeparator": " ",
+    "default": "interactive",
+    "topics": {
+      "deploy": {
+        "description": "Deploy to the permaweb"
+      }
+    }
+  },
+  "files": [
+    "dist",
+    "bin",
+    "oclif.manifest.json"
+  ],
+  "dependencies": {
+    "@ar.io/sdk": "^3.10.1",
+    "@ardrive/turbo-sdk": "^1.28.2",
+    "@inquirer/prompts": "^7.2.0",
+    "@oclif/core": "^4.0.30",
+    "@permaweb/aoconnect": "^0.0.85",
+    "boxen": "^8.0.1",
+    "chalk": "^5.3.0",
+    "cli-table3": "^0.6.5",
+    "mime-types": "^3.0.1",
+    "ora": "^8.1.1"
+  },
+  "devDependencies": {
+    "@changesets/cli": "^2.27.10",
+    "@commitlint/cli": "^19.6.0",
+    "@commitlint/config-conventional": "^19.6.0",
+    "@oclif/prettier-config": "^0.2.1",
+    "@types/mime-types": "^2.1.4",
+    "@types/node": "^22.10.2",
+    "@typescript-eslint/eslint-plugin": "^8.18.1",
+    "@typescript-eslint/parser": "^8.18.1",
+    "@vitest/coverage-v8": "^2.1.8",
+    "eslint": "^8.57.1",
+    "eslint-config-oclif": "^5.2.1",
+    "eslint-config-oclif-typescript": "^3.1.12",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-import-resolver-typescript": "^3.7.0",
+    "eslint-plugin-import": "^2.31.0",
+    "eslint-plugin-prettier": "^5.2.1",
+    "eslint-plugin-simple-import-sort": "^12.1.1",
+    "husky": "^9.1.7",
+    "prettier": "^3.4.2",
+    "tsx": "^4.19.2",
+    "typescript": "^5.7.2",
+    "vite": "^6.0.5",
+    "vite-plugin-dts": "^4.3.0",
+    "vite-tsconfig-paths": "^5.1.4",
+    "vitest": "^2.1.8"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/permaweb/permaweb-deploy.git"
+  },
+  "author": "NickJ202",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/permaweb/permaweb-deploy/issues"
+  },
+  "homepage": "https://github.com/permaweb/permaweb-deploy#readme",
+  "scripts": {
+    "build": "vite build && tsc --emitDeclarationOnly",
+    "dev": "tsx src/index.ts",
+    "test": "vitest",
+    "test:run": "vitest run",
+    "test:coverage": "vitest run --coverage",
+    "lint": "eslint . --ext .ts",
+    "lint:fix": "eslint . --ext .ts --fix",
+    "format": "prettier --write \"src/**/*.ts\"",
+    "format:check": "prettier --check \"src/**/*.ts\"",
+    "changeset": "changeset",
+    "version": "changeset version",
+    "version:alpha": "changeset version --snapshot alpha",
+    "release": "changeset publish",
+    "release:alpha": "changeset publish --tag alpha"
+  }
+}