@tarangdb/cli
v1.0.0-alpha.4
Published
TarangDB CLI for initializing and generating project configuration.
Downloads
95
Maintainers
Readme
@tarangdb/cli
Command-line tools for initializing TarangDB projects and generating JavaScript or TypeScript clients.
Quickstart
npx @tarangdb/cli initFill the generated .env values:
TARANG_API_KEY=
TARANG_PROJECT_ID=
TARANG_BASE_URL=https://api.tarangdb.comThen generate:
npx @tarangdb/cli generateCommands
tarang init
Creates or updates .env, detects JavaScript vs TypeScript, then installs the runtime dependencies your app needs.
For TypeScript projects, init also configures ESM-compatible package and compiler settings for the generated tarang.generated.ts file.
npx @tarangdb/cli initInstalled packages:
- JavaScript projects:
@tarangdb/sdk,dotenv - TypeScript projects:
@tarangdb/sdk,dotenv, and dev dependenciestypescript,tsx,@types/node
TypeScript project config updates:
- sets
package.jsontypetomodule - adds missing
buildanddevscripts - creates or updates
tsconfig.jsonwithmoduleandmoduleResolutionset toNodeNext
Override detection when needed:
npx @tarangdb/cli init --language typescript
npx @tarangdb/cli init --language javascripttarang generate
Fetches schema from Tarang API and writes src/tarang.generated.ts for TypeScript projects or src/tarang.generated.js for JavaScript projects.
npx @tarangdb/cli generateFor local fixtures or CI:
npx @tarangdb/cli generate --schema ./schema.json --output src/tarang.generated.ts
npx @tarangdb/cli generate --schema ./schema.json --output src/tarang.generated.jsGenerated TypeScript exports TarangSchema, tarangSchemaMetadata, and a ready-to-use typed tarang client. Generated JavaScript exports tarangSchemaMetadata and tarang.
Status
This is an alpha release. Use with matching @tarangdb/sdk and @tarangdb/generator versions.
