SDK Reference

@terrantula/sdk is the official TypeScript client for the Terrantula API. It wraps every project-scoped and org-scoped route with typed methods backed by the Hono RPC client.

Install

bun add @terrantula/sdk
# or
npm install @terrantula/sdk

Quick start

import { createClient } from '@terrantula/sdk'

const client = createClient('https://your-terrantula-host', 'your-api-token')

// Get an organization by ID
const org = await client.orgs.get({ id: 'my-org-id' })

Client shape

createClient returns a typed client object with top-level namespaces for every resource:

Namespace	Resource
`client.orgs`	Organizations
`client.projects`	Projects within an org
`client.entities`	Entities (env-scoped)
`client.entityTypes`	Entity type catalog
`client.cells`	Cells
`client.relationships`	Relationships (env-scoped)
`client.relationshipTypes`	Relationship type catalog
`client.actions`	Actions
`client.actionRuns`	Action run records
`client.secrets`	Secrets (env-scoped)
`client.apply`	Catalog apply
`client.catalogRevisions`	Catalog revision history
`client.environments`	Environments
`client.auditEvents`	Audit log
`client.driftEvents`	Drift detection events
`client.stats`	Project statistics
`client.graphViews`	Saved graph views
`client.notifications`	Notifications
`client.auditExport`	Audit export configuration
`client.userPreferences`	User preferences
`client.importSources`	Import source configuration
`client.exportCatalog`	Catalog export
`client.admin`	Admin-only operations
`client.github`	GitHub App integration

Guides

Creating a client — token types, options, project-scoped vs env-scoped access
Error handling — TerrantulaError, withSchema

Generated API surface

The full TypeDoc-generated reference for every exported type, interface, and function is below:

ON THIS PAGE

#SDK Reference

#Install

#Quick start

#Client shape