> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zkterm.io/llms.txt
> Use this file to discover all available pages before exploring further.

# ZK Ecosystem Overview

> Complete suite of zero-knowledge tools for privacy-preserving applications

## The zkTerm Ecosystem

zkTerm provides a complete privacy ecosystem with 5 integrated components.

## Ecosystem Components

| Component         | Description                                 | Status         |
| ----------------- | ------------------------------------------- | -------------- |
| **zkID**          | Universal ZK identity with `did:zk` format  | Live           |
| **zkCompression** | Light Protocol for Solana token compression | Live           |
| **zkToolkit**     | 10-module cryptographic primitives library  | Live           |
| **zkStorage**     | Encrypted IPFS with zkSNARK proofs          | Live           |
| **zkAuth**        | Passwordless social login with STARK proofs | In Development |

## zkID

Privacy-preserving universal identity system.

**Key Features:**

1. `did:zk:[12 alphanumeric chars]` universal DID format
2. Client-side Ed25519 proof generation
3. Dual-chain on-chain verification (Solana Mainnet + Starknet Sepolia)
4. Cairo smart contract for zkID proof storage

```bash theme={null}
zk id register        # Create new zkID
zk id login           # Login to existing zkID
zk id prove           # Generate ZK proof
zk id status          # Check verification status
```

[View zkID Documentation](/zk-ecosystem/zkid)

## zkCompression

Light Protocol integration for Solana ZK Compression.

**Key Features:**

1. Compress SPL tokens to reduce storage costs by 5000x
2. Decompress tokens back to regular SPL tokens
3. Full terminal and API integration
4. Automatic retry polling for RPC indexer sync

```bash theme={null}
zk light compress <amount> --from <wallet>      # Compress SOL
zk light decompress <amount> --from <wallet>    # Decompress SOL
zk light create-token --decimals 9 --from <wallet>  # Create compressed token
zk tokens                                        # View all tokens
```

[View zkCompression Documentation](/zk-ecosystem/zkcompression)

## zkToolkit

Complete ZK cryptographic primitives library with 10 modules.

**Modules:**

| Module    | Operations                 |
| --------- | -------------------------- |
| hash      | Poseidon, Pedersen, MiMC   |
| commit    | Pedersen commitments       |
| merkle    | Trees and inclusion proofs |
| range     | Range proofs               |
| sign      | EdDSA on Baby JubJub       |
| nullifier | Double-spend prevention    |
| field     | BN254 field arithmetic     |
| ec        | Baby JubJub curve ops      |
| shamir    | Secret sharing             |
| proof     | Groth16 zkSNARKs           |

```bash theme={null}
zk toolkit help                          # Show all modules
zk toolkit hash poseidon "hello"         # Hash with Poseidon
zk toolkit field add 5 7                 # Field addition
zk toolkit ec mulbase 12345              # EC scalar multiplication
zk toolkit shamir split "secret" --threshold 3 --shares 5
```

[View zkToolkit Documentation](/zk-ecosystem/zktoolkit)

## zkStorage

Encrypted decentralized file storage with ZK proofs.

**Key Features:**

1. Client-side AES-256-GCM encryption
2. IPFS storage via Pinata
3. Groth16 zkSNARK proofs for password verification
4. SHA-256 checksum validation

```bash theme={null}
zk storage upload              # Upload encrypted file (opens file picker)
zk storage download <file-id>  # Download and decrypt
zk storage list                # List your files
zk storage share <file-id>     # Create shareable link
```

[View zkStorage Documentation](/zk-ecosystem/zkstorage)

## zkAuth

Passwordless authentication with STARK proofs. **Status: In Development**

**Planned Features:**

1. Web3Auth social login (Google, GitHub, X)
2. No passwords, no seed phrases
3. STARK proofs on Starknet for verification
4. Quantum-resistant cryptography

```bash theme={null}
# Planned commands
zk auth login google     # Login with Google
zk auth login github     # Login with GitHub
zk auth status           # Check auth status
```

[View zkAuth Documentation](/zk-ecosystem/zkauth)

## Terminal Access

All ecosystem components are accessible through the zkTerm terminal:

```bash theme={null}
# Visit https://zkterm.io/terminal
# Or use the REST API
```

## API Endpoints

| Endpoint            | Description            |
| ------------------- | ---------------------- |
| `/api/auth/*`       | zkID operations        |
| `/api/light/*`      | Compression operations |
| `/api/zk-toolkit/*` | Toolkit primitives     |
| `/api/storage/*`    | Storage operations     |