Registry / devops / compresskit-cli

compresskit-cli

JSON →
library0.1.1jsnpmunverified

compresskit-cli v0.1.1 is a command-line toolkit for analyzing Solana programs and migrating their accounts to ZK Compression using the Light Protocol SDK. It provides four core commands: analyze (scan for compression opportunities), cost (side-by-side rent comparison), migrate (generate a MIGRATION.md with Rust and TypeScript migration code), and verify (check remaining uncompressed accounts after migration). It also includes a template scaffold command to generate Anchor programs with compressed account patterns for loyalty, gaming, and social use cases. Release cadence is experimental (pre-v1). Key differentiator: end-to-end migration workflow (analysis → costing → code generation → verification) vs. manual Light Protocol integration with no reusable templates.

npm install compresskit-cli
INSTALL
IMPORT
SIG · COMPRESSKIT-CLI
C
compresskit-cli
devopsjavascriptv0.1.1
harness data pending
Install & Compatibility
Where this runs

No compatibility data collected yet for this library.

Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

compresskit
npx compresskit analyze <PROGRAM_ID>
compresskit analyze --network mainnet
CLI is invoked via npx (preferred) or global install. No programmatic API exposed at this version.

Run analysis for a Solana program ID (Tokenkeg...) to discover compressible accounts and estimate rent savings.

npx compresskit analyze TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA
Debug
Known issues
breakingcompresskit migrate does not apply migrations; it only writes a MIGRATION.md plan file.
fix
Manually implement migration steps from MIGRATION.md (Rust + TypeScript snippets provided).
affects: >=0.1.0
breakingThe template command may generate files that overwrite existing ones without warning.
fix
Use --output to specify an empty directory; backup existing files before running.
affects: >=0.1.0
deprecatedThe -n, --network flag default is 'devnet' – committing to mainnet without flag may cause unintended costs.
fix
Always specify --network mainnet when targeting production; defaults to devnet.
affects: >=0.1.0
gotchaThe analyze command's estimated rent uses current Solana rent rate; actual rent may vary after epoch changes.
fix
Re-run cost after program deployment to confirm numbers.
affects: >=0.1.0
gotchaThis CLI does NOT deploy or modify on-chain programs; it is a planning/scaffolding tool.
fix
Use Anchor or Solana CLI for actual deployment; compresskit only generates code and analysis.
affects: >=0.1.0
Errors
Common errors & fixes
Error: Cannot find module '@lightprotocol/compressed-token'
Missing Light Protocol SDK dependency when compiling generated migration code.
fix
Add '@lightprotocol/compressed-token' and '@lightprotocol/stateless.js' to your Cargo.toml / package.json.
Error: expected '=>' after function parameter
Generated MIGRATION.md contains TypeScript snippets without semicolons implicitly assumed; pasting into .ts file may fail if syntax is incomplete.
fix
Review and fix TypeScript snippets manually; use `tsc --noEmit` to catch errors.
Error: AnchorError caused by account: compressed_account. Error Code: AccountOwnedByWrongProgram
Migrated account's owner is not the compresskit template's program ID; migration plan uses a placeholder program.
fix
Replace placeholder program ID (e.g., '9xQeWvG816b...') with your actual program ID in the generated Rust code.
Error: ProgramID not found. Ensure program is deployed on specified network.
Program ID provided to compresskit analyze does not exist on the selected network (default devnet).
fix
Verify program is deployed; pass --network mainnet if targeting mainnet-beta.
Upgrade
Version history
0.1.1latest on npm
Audit
Dependencies

No dependency data recorded yet.

Agent activity
30 hits · last 30 days
node
24
Amazon
1
OpenAI (training)
1
Resources
compresskit-cli — npm install compresskit-cli · libregistry