For the complete flag list on any binary, run neozip -h2, neounzip -h2, or neolist -h2. Agents should prefer neozip schema for machine-readable introspection.
Global agent flags
Shared flags for machine-readable agent integration across neozip, neounzip, and neolist. Use neozip schema to introspect accepted fields before constructing calls.
Syntax: [--format json] [--params '<JSON>'] [--json '<JSON>'] [--dry-run]
| Flag | Description |
|---|---|
| --format json | Emit a single JSON object on stdout ({ ok: true } or { ok: false, error: {...} }) |
| --params '<JSON>' | Control options object (level, encrypt, blockchain, network, exdir, ...) |
| --json '<JSON>' | Payload object (archive + files/targets); use - to read from stdin |
| --dry-run | Resolve and print the plan as JSON without writing (neozip, neounzip) |
| --legacy | InfoZip/PKZIP-compatible output (deflate/store + PKZIP encryption; disables NeoZip extensions) |
Examples
bash
# Introspect before calling
neozip schema neozip
# JSON-driven create
neozip --format json \
--params '{"level":9,"encrypt":true,"password":"s3cret"}' \
--json '{"archive":"out.zip","files":["src/"]}'
# InfoZip-compatible archive
neozip --format json --params '{"legacy":true,"level":9}' \
--json '{"archive":"compat.zip","files":["src/"]}'neozip
Create, update, and manage ZIP archives. Supports recursion, encryption, compression levels, blockchain features, and agent JSON I/O.
Syntax: neozip [options] <archive> [files...]
| Flag | Description |
|---|---|
| -r, --recurse | Include subdirectories recursively |
| -0 … -9, --level | Compression level (0 = store, 9 = best) |
| --compression zstd|deflate|store | Compression method (default: zstd) |
| -e, --encrypt | Encrypt with AES-256 (prompts for password) |
| -P, --password <pwd> | Encrypt with the given password |
| --aes256 | Use AES-256 encryption (recommended default) |
| --pkzip | Legacy PKZIP encryption (compatibility only) |
| -b, --blockchain | Enable on-chain tokenization (signs locally with Data Wallet) |
| -ts, --timestamp | Token Service timestamp (Ethereum; requires neozip connect) |
| -ots, --opentimestamp | OpenTimestamp proof (Bitcoin) |
| --legacy | InfoZip-compatible archive; hard error if combined with blockchain flags |
| --format json | Structured JSON output on stdout |
| --params / --json | Agent input (see Global agent flags) |
| --dry-run | Preview create plan without writing |
| -x, --exclude <pattern> | Exclude files matching pattern |
| -i, --include <pattern> | Include only matching files |
| -u, --update | Update existing entries in archive |
| -m, --move | Move files into archive |
| -d, --delete | Delete files from archive |
| -T, --test-integrity | Test archive after creation |
| -@ | Read file paths from stdin |
| -v, --verbose | Enable verbose output |
| -q, --quiet | Suppress output |
| -h / -h2 | Help / extended help |
| -V, --version | Show version |
Subcommands
neozip connect [subcommand]
Token Service account + Data Wallet setup (alias: neozip init). See neozip connect section.
neozip config
Connection dashboard — status, preferences, migrate
neozip upgrade <archive> [output] [--wait]
Upgrade pending Token Service timestamp to confirmed
neozip mint <archive> [output] [-n network]
Mint TimestampProofNFT from a confirmed timestamped archive
neozip skills <subcommand>
Install, list, and pack bundled Agent Skills. See neozip skills section.
neozip schema <neozip|neounzip|neolist|connect>
Emit accepted fields, types, defaults, and exit codes as JSON
Examples
bash
# Recursive archive with exclusions
neozip -r -x "*.log" archive.nzip ./project/
# Compress paths from stdin
find . -name "*.txt" | neozip -@ archive.nzip
# Tokenize with Token Service timestamp (JSON)
neozip --format json \
--params '{"blockchain":true,"blockchainTokenService":true,"network":"base-sepolia"}' \
--json '{"archive":"tokenized.nzip","files":["contract.pdf"]}'neounzip
Extract, test, or list archive contents. Auto-detects AES-256 and PKZIP encryption. Refuses zip-slip paths.
Syntax: neounzip [options] <archive> [destination] [file_patterns...]
| Flag | Description |
|---|---|
| -d, --exdir <dir> | Extract to a specific directory |
| -o, --overwrite | Overwrite files without prompting |
| -t, --test | Test archive integrity (no extract) |
| -l, --list | List contents without extracting |
| -P, --password [pwd] | Password for encrypted archives (AES-256/PKZIP auto-detected) |
| --pre-verify | Verify on-chain integrity before extraction |
| -j, --junk-paths | Extract without directory structure |
| -x, --exclude <pattern> | Exclude files from extraction |
| -i, --include <pattern> | Include only matching files |
| --format json | Structured JSON output on stdout |
| --params / --json | Agent input (see Global agent flags) |
| --dry-run | Preview extraction plan without writing |
| --skip-blockchain | Skip blockchain verification steps |
| -v, --verbose | Enable verbose output |
| -q, --quiet | Suppress output |
| -h / -h2 | Help / extended help |
| -V, --version | Show version |
Examples
bash
# Extract to a directory
neounzip archive.nzip tests/extracted/
# Test integrity
neounzip -t archive.nzip
# Extract with on-chain integrity check
neounzip --pre-verify tokenized.nzip verified/
# Agent-style extract
neounzip --format json --params '{"exdir":"out","overwrite":true}' \
--json '{"archive":"in.zip"}'neolist
List and inspect ZIP archive contents in human-readable or JSON formats.
Syntax: neolist [options] <archive> [file_patterns...]
| Flag | Description |
|---|---|
| -v, --verbose | Detailed listing |
| -s, --short | Short format |
| -j, --json | Output as JSON (alias for --format json) |
| --format json | Structured JSON output on stdout |
| -u, --unix | Unix-style listing |
| -b, --basic | Basic listing |
| -1 | Filenames only |
| -2 | Filenames with header and totals |
| -i, --include <pattern> | Include only matching files |
| -x, --exclude <pattern> | Exclude matching files |
| -S, --sort name|size|date | Sort output |
| -h / -h2 | Help / extended help |
| -V, --version | Show version |
Examples
bash
# Basic listing
neolist archive.nzip
# Verbose listing
neolist -v archive.nzip
# JSON output (agent-friendly)
neolist --format json archive.nzipneozip connect
Set up the NeoZip Token Service account and local Data Wallet. Configuration lives in ~/.neozip/connection/ (shared with NeoZip Desktop and NeoZip MCP). Token Service URL, verified email, and access token are read only from the connection store.
Syntax: neozip connect [subcommand] [options]
| Flag | Description |
|---|---|
| --json | Structured JSON output on non-interactive subcommands |
| --email <addr> | Email for register, verify, or refresh OTP flows |
| --code <code> | Verification or refresh OTP code |
| --ack-backup | Acknowledge wallet backup prompt (wallet create) |
| --network <name> | Override default network (e.g. base-sepolia) |
| --chain <id> | Target chain ID for fund requests |
Subcommands
neozip connect
Interactive setup (alias: neozip init). Requires a TTY — use explicit subcommands for agents.
neozip connect status [--json]
Show connection phase, credentials, and access-token expiry
neozip connect register --email <addr> [--json]
Register email with Token Service
neozip connect verify --email <addr> --code <code> [--json]
Verify email with OTP code
neozip connect refresh [--json]
Renew access token — prefers silent wallet-signature login; falls back to email OTP
neozip connect wallet create [--ack-backup] [--json]
Create local Data Wallet in connection store
neozip connect finish [--json]
Complete setup after register, verify, and wallet steps
neozip connect migrate [--json]
Import legacy wallet.json or MCP profiles
neozip connect settings
Default network, RPC overrides, gas preferences
neozip connect fund [--network <name>] [--json]
Request testnet gas grant to primary linked wallet (default action)
neozip connect fund status [--json]
Eligibility and recent grants (no spend)
neozip connect fund policy [--json]
Grant size and cooldown (no auth required)
Examples
bash
# Scripted agent setup
neozip connect register --email you@example.com --json
neozip connect verify --email you@example.com --code 123456 --json
neozip connect wallet create --ack-backup --json
neozip connect finish --json
# Silent token renewal and gas funding
neozip connect refresh --json
neozip connect fund status --json
neozip connect fund --jsonneozip skills
Manage bundled Agent Skills shipped inside the npm package. Skills cover JSON I/O, create, extract, list, connect, and legacy mode.
Syntax: neozip skills <subcommand> [options]
| Flag | Description |
|---|---|
| --target claude | Install to Claude Code skills directory only |
| --output-dir <path> | Output directory for pack subcommand |
Subcommands
neozip skills path
Show where bundled skills live in the install
neozip skills list
List available bundled skills
neozip skills install [--target claude]
Symlink skills into ~/.claude/skills and/or ~/.cursor/skills
neozip skills pack --output-dir <path>
Create ZIP per skill for Claude Cowork / claude.ai upload
Examples
bash
neozip skills install
neozip skills install --target claude
neozip skills path
neozip skills list
neozip skills pack --output-dir ./neozip-skills-zipsneozip schema
Introspection command for agents. Emits accepted --params fields, --json payload shape, defaults, and exit codes as JSON.
Syntax: neozip schema <neozip|neounzip|neolist|connect>
Examples
bash
neozip schema neozip
neozip schema neounzip
neozip schema neolist
neozip schema connectconfig / upgrade / mint
Utility commands for connection management and blockchain archive lifecycle beyond basic create/extract.
Syntax: neozip config | neozip upgrade <archive> [output] [--wait] | neozip mint <archive> [output]
| Flag | Description |
|---|---|
| --wait | Wait for Token Service timestamp confirmation (upgrade) |
| -n, --network <name> | Network for mint (e.g. base-sepolia) |
Subcommands
neozip config
Connection dashboard — status, preferences, migrate
neozip upgrade <archive> [output] [--wait]
Upgrade pending Token Service timestamp to confirmed
neozip mint <archive> [output] [-n network]
Mint TimestampProofNFT from a confirmed timestamped archive
Examples
bash
neozip config
neozip upgrade timestamped.nzip --wait
neozip mint timestamped.nzip -n base-sepoliaNeed AI integration guides, Skills installation, or Token Service setup?