https://github.com/pskinnertech/permalaunch
A new CLI tool that makes deploying to Arweave easy for all developer levels.
https://github.com/pskinnertech/permalaunch
Last synced: 12 months ago
JSON representation
A new CLI tool that makes deploying to Arweave easy for all developer levels.
- Host: GitHub
- URL: https://github.com/pskinnertech/permalaunch
- Owner: PSkinnerTech
- License: mit
- Created: 2024-12-16T03:49:08.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-31T08:52:40.000Z (about 1 year ago)
- Last Synced: 2025-06-07T09:17:23.674Z (about 1 year ago)
- Language: TypeScript
- Size: 39.3 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Roadmap: docs/ROADMAP.md
Awesome Lists containing this project
README
# Permalaunch
Deploy your web apps to the permaweb with ease! Permalaunch is a CLI tool that simplifies the process of deploying applications to Arweave.
## BETA
This is a beta release. Please report any issues to [https://github.com/pskinnertech/permalaunch/issues](https://github.com/pskinnertech/permalaunch/issues)
When this tool is ready for production, it will be renamed, this CLI will be deprecated, and the tool will be moved to a new repository.
## Features
- 🚀 One-command deployment to Arweave
- 🔍 Comprehensive pre-launch checks
- 🌐 ANT (Arweave Name System) integration
- 🔄 Git integration for versioning
- ⚡ Quick launch option for rapid deployments
- 💳 Balance and cost estimation
- 📁 Support for multiple build types (dist, build, .next)
## Quick Start
1. Initialize your deployment key:
```bash
npx permalaunch init
```
2. Deploy your app:
```bash
npx permalaunch --launch
```
## Usage
### Basic Commands
```bash
npx permalaunch --init # Set up your wallet securely
npx permalaunch --launch # Full deployment with checks
npx permalaunch --quick-launch # Quick deployment without checks
```
### Individual Check Commands
```bash
npx permalaunch --check-wallet # Verify wallet configuration
npx permalaunch --check-balances # Check balances and estimate costs
npx permalaunch --check-build # Validate build folder
npx permalaunch --check-ant # Verify ANT configuration
npx permalaunch --check-git # Check Git configuration
```
### Balance Check Command
The balance check command verifies your wallet's financial readiness:
- Validates wallet configuration
- Checks WINC and AR balances
- Estimates deployment costs
- Provides funding guidance
Example output:
```bash
CHECK BALANCES:
[ x ] Turbo Balance: 1000000 WINC
[ x ] AR Balance: 1.5 AR
[ x ] Estimated Deployment Cost: 500000 WINC
```
## Documentation
For detailed documentation:
- [Error Messages](docs/ERROR-MESSAGES.md)
- [Contributing Guide](CONTRIBUTING.md)
- [Roadmap](docs/ROADMAP.md)
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
Copyright (c) 2024 Patrick Skinner (PSkinnerTech)