neozip-cli 0.70.0-alpha

package/CHANGELOG.md

@@ -0,0 +1,72 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.70.0-alpha] - 2025-11-21
+
+### ⚠️ Alpha Release Notice
+
+This is the first alpha release of NeoZip CLI. This software is in early development and may contain bugs, incomplete features, or breaking changes. Use at your own risk.
+
+### Added
+
+#### Core Commands
+- **`neozip`** - Create and manage ZIP archives
+  - Multiple compression methods: Zstd (default), Deflate, Store
+  - Compression levels 0-9
+  - Recursive directory processing
+  - Pattern-based file inclusion/exclusion
+  - Archive and file comments
+  - Update, freshen, move, and delete operations
+
+- **`neounzip`** - Extract files from ZIP archives
+  - Selective extraction with patterns
+  - Archive integrity testing
+  - Progress reporting
+  - Overwrite control
+
+- **`neolist`** - List archive contents
+  - Multiple output formats (verbose, short, JSON, Unix-style)
+  - Detailed metadata display
+
+#### Compression & Encryption
+- Zstd compression (default) with streaming support
+- Deflate compression for maximum compatibility
+- Store method for already-compressed files
+- PKZIP legacy encryption support
+
+#### Blockchain Features
+- Archive tokenization (NFT creation) on Ethereum, Base and Arbitrum networks
+- OpenTimestamp integration for Bitcoin blockchain timestamping
+- Interactive wallet setup (`neozip init`)
+- Configuration management (`neozip config`)
+
+#### Advanced Features
+- Symbolic and hard link handling
+- File permission preservation
+- Line ending conversion (CRLF/LF)
+- Progress reporting
+- ZIP64 support for large files
+
+### Known Limitations
+
+- **API Stability**: Command-line interface may change in future releases
+- **Missing Features**: Archive repair, auto-convert, self-extracting archives, and pager support not yet implemented
+- **Platform Testing**: Limited testing on Windows and some Linux distributions
+- **Blockchain**: Requires wallet configuration; some RPC endpoints may timeout
+
+### Documentation
+
+- Comprehensive README with usage examples
+- Distribution and NPM publishing guides
+- Troubleshooting documentation
+
+---
+
+**For more information:**
+- [README.md](README.md) - Usage guide and examples
+- [WHY_NEOZIP.md](WHY_NEOZIP.md) - Project vision and use cases
+- [Documentation Index](DOCUMENTATION.md) - Full documentation

package/DOCUMENTATION.md

@@ -0,0 +1,194 @@
+# NeoZip CLI Documentation
+
+## 📚 Documentation Index
+
+This document provides an overview of all available documentation for NeoZip CLI.
+
+## 🚀 Quick Start
+
+### Installation
+```bash
+npm install -g neozip-cli@alpha
+```
+
+### Basic Usage
+```bash
+# Create a ZIP archive
+neozip archive.nzip file1.txt file2.txt folder/
+
+# Extract files from archive
+neounzip archive.nzip extracted/
+
+# List archive contents
+neolist archive.nzip
+```
+
+### Help Commands
+```bash
+neozip --help      # Show ZIP creation help
+neounzip --help    # Show extraction help
+neolist --help     # Show listing help
+```
+
+## 📖 Core Documentation
+
+### User Documentation
+
+- **[README.md](README.md)** - Main project documentation
+  - Installation instructions
+  - Feature overview
+  - Command reference
+  - Usage examples
+  - Troubleshooting guide
+
+- **[WHY_NEOZIP.md](WHY_NEOZIP.md)** - Project vision and use cases
+  - Introduction to blockchain-enabled archives
+  - Use cases and applications
+  - NeoZip ecosystem overview
+  - Technical innovations
+
+- **[CHANGELOG.md](CHANGELOG.md)** - Version history
+  - Release notes
+  - Feature additions
+  - Known limitations
+  - Breaking changes
+
+- **[env.example](env.example)** - Environment variable configuration
+  - Wallet configuration
+  - Network settings
+  - RPC endpoint configuration
+  - Debug and gas settings
+
+## 🎯 Key Features
+
+### Core Commands
+
+- **`neozip`** - Create and manage ZIP archives
+  - Multiple compression methods (Zstd, Deflate, Store)
+  - Compression levels 0-9
+  - Recursive directory processing
+  - Pattern-based file inclusion/exclusion
+  - Archive and file comments
+  - Update, freshen, move, and delete operations
+
+- **`neounzip`** - Extract files from ZIP archives
+  - Selective extraction with patterns
+  - Archive integrity testing
+  - Progress reporting
+  - Overwrite control
+  - Password-protected archive support
+
+- **`neolist`** - List archive contents
+  - Multiple output formats (verbose, short, JSON, Unix-style)
+  - Detailed metadata display
+  - Filename-only output
+
+### Compression & Encryption
+
+- **Zstd Compression** (default)
+  - Modern, fast compression algorithm
+  - Better compression ratios than deflate
+  - Streaming support for large files
+
+- **Deflate Compression**
+  - Standard ZIP compression method
+  - Maximum compatibility with other ZIP tools
+
+- **Store Method**
+  - No compression (fastest)
+  - Useful for already-compressed files
+
+- **PKZIP Encryption**
+  - Legacy encryption for maximum compatibility
+  - Password-protected archives
+  - InfoZip-compatible encrypted archives
+
+### Blockchain Features
+
+- **Archive Tokenization**
+  - Create on-chain tokens (NFTs) for archives
+  - Network support: Ethereum Sepolia, Base Sepolia, Base Mainnet, Arbitrum Sepolia, Arbitrum One
+  - Automatic token selection or force mint new tokens
+  - Archive integrity verification on-chain
+
+- **OpenTimestamp**
+  - Bitcoin blockchain timestamping
+  - Cryptographic proof of archive existence
+  - Timestamp verification
+
+- **Wallet Integration**
+  - Interactive wallet setup wizard (`neozip init`)
+  - Configuration management (`neozip config`)
+  - Environment variable support
+  - Secure wallet key storage
+
+### Advanced Features
+
+- Symbolic and hard link handling
+- File permission preservation
+- Line ending conversion (CRLF/LF)
+- Progress reporting
+- ZIP64 support for large files (>4GB)
+- Stdin filename input
+- Archive and file comments
+
+## 🔧 Configuration
+
+### Wallet Setup
+
+For blockchain features, configure your wallet:
+
+```bash
+# Interactive setup wizard
+neozip init
+
+# View or modify configuration
+neozip config
+```
+
+Configuration is stored in `~/.neozip/wallet.json` and supports:
+- Wallet private key
+- Network selection (testnet/mainnet)
+- Custom RPC endpoints
+- Gas settings
+- Debug options
+
+### Environment Variables
+
+You can also configure via environment variables (see [env.example](env.example)):
+- `NEOZIP_WALLET_PASSKEY` - Wallet private key
+- `NEOZIP_NETWORK` - Blockchain network
+- `NEOZIP_BASE_SEPOLIA_RPC_URL` - Custom RPC endpoints
+- `NEOZIP_VERBOSE` - Enable verbose logging
+- `NEOZIP_DEBUG` - Enable debug mode
+
+## 📚 Reading Order
+
+1. **Start with** [README.md](README.md) for installation and basic usage
+2. **Read** [WHY_NEOZIP.md](WHY_NEOZIP.md) to understand the project vision
+3. **Review** [CHANGELOG.md](CHANGELOG.md) for version history and known issues
+4. **Configure** wallet using `neozip init` for blockchain features
+5. **Reference** [env.example](env.example) for environment variable configuration
+
+## 🔗 Related Links
+
+- [ZIP Specification](https://pkware.cachefly.net/webdocs/casestudies/APPNOTE.TXT) - Official ZIP format documentation
+- [NeoZip Website](https://neozip.io) - Project website and information
+
+## 📞 Support
+
+For issues or questions:
+
+1. **Check** the troubleshooting sections in [README.md](README.md)
+2. **Review** [CHANGELOG.md](CHANGELOG.md) for known issues
+3. **Test** with the provided examples
+4. **Verify** your command syntax with `--help` flags
+5. **Report** issues via:
+   - Email: [support@neozip.io](mailto:support@neozip.io)
+   - GitHub: [NeoZip Support Repository](https://github.com/NeoWareInc/neozip-support/issues) (public issue tracker)
+
+---
+
+**Version**: 0.70.0-alpha  
+**Status**: Alpha Release  
+**Last Updated**: 2025-11-21

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2025 NeoWare, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+