square-terminalTreza CLI

Command-line interface for the Treza platform

npm versionarrow-up-right Licensearrow-up-right Documentationarrow-up-right


Manage secure enclaves, verify KYC proofs, and interact with the Treza platform directly from your terminal.

Installation

npm install -g @treza/cli

Or with yarn:

yarn global add @treza/cli

Quick Start

# Configure the CLI with your wallet
treza config init

# List your enclaves
treza enclave list

# Create an enclave from a Docker image
treza enclave create \
  --name "My Enclave" \
  --source-type registry \
  --image nginx:latest \
  --region us-west-2

# Create an enclave from a GitHub repository
treza enclave create \
  --name "My App Enclave" \
  --source-type github \
  --github-repo https://github.com/my-org/my-app \
  --github-branch main \
  --region us-west-2

Commands

Configuration

Enclaves

List & inspect

Create

Enclaves support three deployment sources:

From a public Docker / container registry image:

From a GitHub repository (Treza builds the image automatically):

Your repository must contain a Dockerfile at its root. The build status will progress through PENDING_BUILD → BUILDING → PENDING_DEPLOY → DEPLOYING → DEPLOYED.

From a private container registry:

Provider & hardware options

Flag
Description
Default

--provider <id>

Provider ID

aws-nitro

--instance-type <type>

EC2 instance type

m6i.xlarge

--cpu <count>

vCPU count for the enclave

2

--memory <mib>

Memory in MiB for the enclave

1024

--workload-type <type>

service or task

service

Lifecycle management

Logs

KYC Verification

Tasks

Providers

Global Options

Configuration

The CLI stores configuration in a local config file:

Setting
Description
Default

walletAddress

Your Ethereum wallet address

Required

apiUrl

Treza API endpoint

https://app.trezalabs.com

apiKey

Optional API key for authenticated requests

Configuration is stored at:

  • macOS: ~/Library/Preferences/treza-cli-nodejs/config.json

  • Linux: ~/.config/treza-cli-nodejs/config.json

  • Windows: %APPDATA%/treza-cli-nodejs/config.json

Examples

Deploy from a GitHub repository

Deploy from Docker Hub

Deploy from a private registry

Verify KYC proofs

Scripting and automation

Enclave Status Lifecycle

Status
Description

PENDING_BUILD

Waiting to start building from GitHub source

BUILDING

AWS CodeBuild is building the Docker image

BUILD_FAILED

Build failed — check build logs

PENDING_DEPLOY

Image ready, waiting to deploy

DEPLOYING

EC2 Nitro instance is being provisioned

DEPLOYED

Running and healthy

PAUSED

Instance stopped

TERMINATED

Instance terminated

Development

Support

License

MIT License - see LICENSE file for details.


Built by Treza Labsarrow-up-right — Privacy infrastructure for the next era of finance.

Last updated