Installation, quick starts, encryption, compression, and blockchain APIs. Use NeoZipKit for ZIP creation and NeoEncrypt / WinZip AES-256. Use NeoZip-blockchain for Token Service timestamping, NFT minting, and token verification. NeoZip CLI documentation and NeoZip MCP documentation live on dedicated pages. Download the NeoZip Application Note for the .nzip wire-format profile.
The NeoZip Application Note (v0.1.1) defines the .nzip ZIP profile — compression defaults, encryption (including optional recipient / hybrid access control), integrity, and blockchain / Token Service extensions. It extends PKWARE APPNOTE 6.3.10 and is the normative reference for NeoZip-aware tools implementing NeoZipKit.
npm
npm install neozipkityarn
yarn add neozipkittypescript
import { ZipkitBrowser } from 'neozipkit/browser-esm';
const zip = new ZipkitBrowser();
await zip.addFile(file, { level: 6 });
const zipBlob = await zip.createZipBlob();typescript
import { ZipkitNode } from 'neozipkit/node';
const zip = new ZipkitNode();
// Create a ZIP from files
await zip.createZipFromFiles(['file1.txt', 'file2.txt'], 'output.zip');
// Extract a ZIP file
await zip.extractZipFile('archive.zip', './output');typescript
import { ZipkitBrowser } from 'neozipkit/browser-esm';
const zip = new ZipkitBrowser();
await zip.loadZipBlob(zipBlob);
// Verify file integrity
const entries = zip.getDirectory();
for (const entry of entries) {
const isValid = await zip.verifyEntry(entry);
console.log(`${entry.filename}: ${isValid ? 'Valid' : 'Invalid'}`);
}NeoZipKit v1.0.5 supports NeoEncrypt AES-256 by default and WinZip-compatible AES-256 (AE-1/AE-2). Create and extract encrypted archives in Node.js and browser. Use password and optionally encryptionMethod: 'aes256' in compress options for WinZip AES.
typescript
import { ZipkitNode } from 'neozipkit/node';
const zip = new ZipkitNode();
await zip.createZipFromFiles(
['file1.txt', 'file2.txt'],
'secure.zip',
{
password: 'your-secure-password',
encryptionMethod: 'aes256'
}
);typescript
import { ZipkitNode } from 'neozipkit/node';
const zip = new ZipkitNode();
await zip.extractZipFile('secure.zip', './output', {
password: 'your-secure-password'
});
// Auto-detects AES-256 or legacy ZIP encryptionSee neozipkit on npm for examples: create-aes-zip.ts, extract-aes-zip.ts.
NeoZipKit supports multiple compression algorithms to suit different use cases:
typescript
import { CompressOptions, CMP_METHOD } from 'neozipkit';
// Deflate compression
const deflateOptions: CompressOptions = {
useZstd: false,
level: 6
};
// ZStandard compression
const zstdOptions: CompressOptions = {
useZstd: true,
level: 3
};
// Stored (no compression)
const storedOptions: CompressOptions = {
cmpMethod: CMP_METHOD.STORED
};NeoZip-blockchain is the companion library for all blockchain features. Use with NeoZipKit for full NZIP workflows.
npm
npm install neozip-blockchainyarn
yarn add neozip-blockchainFor full NZIP workflows: npm install neozipkit@^1.0.5 neozip-blockchain@^1.0.5
typescript
import { ZipkitMinter } from 'neozip-blockchain';
const minter = new ZipkitMinter('merkleRoot123...', {
walletPrivateKey: '0x...',
network: 'base-sepolia'
});
const result = await minter.mintToken();
console.log(`Token ID: ${result.tokenId}`);typescript
import { ZipkitVerifier } from 'neozip-blockchain';
const verifier = new ZipkitVerifier({ debug: false });
// Verify token metadata
const result = await verifier.verifyToken(tokenMetadata);
if (result.success) {
console.log('Token verified!');
}typescript
import { createTimestamp, verifyOtsZip } from 'neozip-blockchain/ots';
// Create timestamp for a file's hash
const otsProof = await createTimestamp(merkleRoot);
// Verify a loaded ZIP file
const result = await verifyOtsZip(zipInstance);
if (result.status === 'valid') {
console.log('Verified! Block:', result.blockHeight);
}typescript
import { ZipkitNode } from 'neozipkit/node';
import { ZipkitMinter, ZipkitVerifier } from 'neozip-blockchain';
// Create and tokenize a ZIP
const zip = new ZipkitNode();
await zip.createZipFromFiles(files, 'archive.zip', { useSHA256: true });
// Get merkle root from ZIP
const merkleRoot = zip.getMerkleRoot();
// Mint as NFT
const minter = new ZipkitMinter(merkleRoot, {
walletPrivateKey: process.env.WALLET_KEY,
network: 'base-sepolia'
});
const result = await minter.mintToken();Installation, AI agent integration, bundled Skills, Token Service setup, usage examples, and the full command reference for neozip, neounzip, and neolist are on the dedicated CLI pages.
Product overview, industry use cases, and setup docs for neozip-mcp — including Claude workspace, Cursor, MCP tools, and NeoZip Connect — live on dedicated MCP pages.
Both NeoZipKit and NeoZip-blockchain are written in TypeScript with comprehensive type definitions. All APIs are fully typed with IntelliSense support for better developer experience.
typescript
import type { ZipEntry, CompressOptions } from 'neozipkit';
// NeoZipKit types
const entry: ZipEntry = zip.getZipEntry('file.txt');
const options: CompressOptions = { useZstd: true, level: 3 };Install NeoZipKit and NeoZip-blockchain to build blockchain-secured ZIP file applications.