Installing TERE
This guide walks you through installing and configuring the TERE SDK and CLI tools. TERE supports multiple platforms and can be integrated with various development environments.
Prerequisites
Before installing TERE, make sure you have the following:
- Node.js 18.0.0 or later
- npm 7.0.0 or later (or yarn/pnpm)
- For local development: Docker Desktop 4.0.0 or later
- For production: Access to a cloud provider with confidential computing support
For local development and testing, TERE provides a TEE simulator that doesn't require specialized hardware.
Installing the TERE SDK
The TERE SDK is available as an npm package. To install it in your project:
This will install the TERE SDK and its dependencies in your project.
Installing the TERE CLI
The TERE CLI allows you to interact with TERE from the command line. It's recommended to install it globally:
Verify the installation by running:
You should see the version number of the installed CLI tool.
Setting Up Authentication
To use TERE, you'll need to authenticate with your API key. You can obtain an API key from the TERE dashboard.
Using the CLI
Log in using the CLI:
Using the SDK
When using the SDK in your code, initialize the client with your API key:
Keep your API key secure and never commit it to version control. Consider using environment variables to store it.
Installing the Local Development Environment
For local development and testing, TERE provides a local development environment that simulates a Trusted Execution Environment:
The local development environment runs in Docker and provides a simulated TEE for testing your applications without needing actual hardware-backed TEEs.
Cloud Provider Setup
For production deployments, TERE supports the following cloud providers with confidential computing capabilities:
Google Cloud Platform
- Confidential VMs
- Confidential GKE Nodes
- AMD SEV & SEV-SNP support
Troubleshooting
Common Installation Issues
Issue | Solution |
---|---|
SDK installation fails with dependency errors | Ensure Node.js is updated to version 18 or later. Try clearing npm cache with npm cache clean --force before reinstalling. |
CLI not found after global installation | Make sure your PATH includes the global npm bin directory. You might need to restart your terminal or add the npm bin path to your environment variables. |
Docker container fails to start for local development | Ensure Docker Desktop is running. Check Docker logs for any errors. You might need to increase the allocated memory for Docker if you see out-of-memory errors. |
If you encounter issues not covered here, please check our comprehensive troubleshooting guide.