Skip to content

Same agent Smaller bill. The tools and infrastructure to get more work from your AI. Fewer tokens. Less compute. Lower cost.

[Feat]: Change TS SDK name from `@openlit/ts` to `openlit` (#394)

patcher9b9fc3b0746b2
diff --git a/docs/latest/integrations/anthropic.mdx b/docs/latest/integrations/anthropic.mdx
index 38854ff6..37dea683 100644
--- a/docs/latest/integrations/anthropic.mdx
+++ b/docs/latest/integrations/anthropic.mdx
@@ -28,7 +28,7 @@ The integration is compatible with
</Tab>
<Tab title="Typescript">
```shell
- npm install @openlit/ts
+ npm install openlit
```
</Tab>
</Tabs>
@@ -55,7 +55,7 @@ The integration is compatible with
<Warning>Typescript sdk for anthropic doesn't support metrics tracking for now!</Warning>
```typescript
- import openlit from "@openlit/ts"
+ import openlit from "openlit"
openlit.init({ otlpEndpoint: "YOUR_OTEL_ENDPOINT" })
```
@@ -80,7 +80,7 @@ The integration is compatible with
</Tab>
<Tab title="Typescript">
```typescript
- import openlit from "@openlit/ts"
+ import openlit from "openlit"
openlit.init()
```
diff --git a/docs/latest/integrations/openai.mdx b/docs/latest/integrations/openai.mdx
index 984a4ece..cfd14f94 100644
--- a/docs/latest/integrations/openai.mdx
+++ b/docs/latest/integrations/openai.mdx
@@ -28,7 +28,7 @@ The integration is compatible with
</Tab>
<Tab title="Typescript">
```shell
- npm install @openlit/ts
+ npm install openlit
```
</Tab>
</Tabs>
@@ -54,7 +54,7 @@ The integration is compatible with
<Warning>Typescript sdk for openai doesn't support metrics tracking for now!</Warning>
```typescript
- import openlit from "@openlit/ts"
+ import openlit from "openlit"
openlit.init({ otlpEndpoint: "YOUR_OTEL_ENDPOINT" })
```
@@ -81,7 +81,7 @@ The integration is compatible with
</Tab>
<Tab title="Typescript">
```typescript
- import openlit from "@openlit/ts"
+ import openlit from "openlit"
openlit.init()
```
diff --git a/docs/latest/quickstart.mdx b/docs/latest/quickstart.mdx
index 5381d9ac..a161fda3 100644
--- a/docs/latest/quickstart.mdx
+++ b/docs/latest/quickstart.mdx
@@ -48,7 +48,7 @@ flowchart TB;
</Tab>
<Tab title="Typescript">
```shell
- npm install @openlit/ts
+ npm install openlit
```
</Tab>
</Tabs>
@@ -91,7 +91,7 @@ flowchart TB;
</Tab>
<Tab title="Typescript">
```typescript
- import Openlit from "@openlit/ts"
+ import Openlit from "openlit"
Openlit.init({ otlpEndpoint: "http://127.0.0.1:4318/v1/traces" })
```
@@ -99,7 +99,7 @@ flowchart TB;
Example Usage for monitoring `OpenAI` Usage:
```typescript
- import Openlit from "@openlit/ts"
+ import Openlit from "openlit"
Openlit.init({ otlpEndpoint: "http://127.0.0.1:4318/v1/traces" })
@@ -119,7 +119,7 @@ flowchart TB;
```
OR
```typescript
- import openlit from "@openlit/ts"
+ import openlit from "openlit"
import OpenAI from "openai"
openlit.init({
@@ -188,7 +188,7 @@ flowchart TB;
<Tab title="Typescript">
Add the following two lines to your application code:
```typescript
- import openlit from "@openlit/ts"
+ import openlit from "openlit"
openlit.init()
```
@@ -201,7 +201,7 @@ flowchart TB;
Example Usage for monitoring `OpenAI` Usage:
```typescript
- import openlit from "@openlit/ts"
+ import openlit from "openlit"
openlit.init()
@@ -221,7 +221,7 @@ flowchart TB;
```
OR
```typescript
- import openlit from "@openlit/ts"
+ import openlit from "openlit"
import OpenAI from "openai"
openlit.init({
diff --git a/sdk/typescript/README.md b/sdk/typescript/README.md
index 798f4e37..9e8db98f 100644
--- a/sdk/typescript/README.md
+++ b/sdk/typescript/README.md
@@ -6,7 +6,7 @@ OpenTelemetry Auto-Instrumentation for GenAI & LLM Applications</h1>
[![OpenLIT](https://img.shields.io/badge/OpenLIT-orange)](https://github.com/openlit/openlit)
[![License](https://img.shields.io/github/license/openlit/openlit?label=License&logo=github&color=f80&logoColor=white)](https://github.com/openlit/openlit/blob/main/LICENSE)
-[![Downloads](https://img.shields.io/npm/dm/%40openlit%2Fts)](https://www.npmjs.com/package/@openlit/ts)
+[![Downloads](https://img.shields.io/npm/dm/%40openlit%2Fts)](https://www.npmjs.com/package/openlit)
[![GitHub Last Commit](https://img.shields.io/github/last-commit/openlit/openlit)](https://github.com/openlit/openlit/pulse)
[![GitHub Contributors](https://img.shields.io/github/contributors/openlit/openlit)](https://github.com/openlit/openlit/graphs/contributors)
@@ -50,7 +50,7 @@ This project adheres to the [Semantic Conventions](https://github.com/open-telem
## 💿 Installation
```bash
-npm install @openlit/ts
+npm install openlit
```
## 🚀 Getting Started
@@ -60,7 +60,7 @@ npm install @openlit/ts
Open your command line or terminal and run:
```bash
-npm install @openlit/ts
+npm install openlit
```
### Step 2: Initialize OpenLIT in your Application
@@ -68,7 +68,7 @@ npm install @openlit/ts
Integrating the OpenLIT into LLM applications is straightforward. Start monitoring for your LLM Application with just **two lines of code**:
```typescript
-import Openlit from '@openlit/ts';
+import Openlit from 'openlit';
Openlit.init();
```
@@ -91,7 +91,7 @@ To send telemetry to OpenTelemetry backends requiring authentication, set the `o
Add the following two lines to your application code:
```typescript
-import Openlit from '@openlit/ts';
+import Openlit from 'openlit';
Openlit.init({
otlpEndpoint: 'YOUR_OTEL_ENDPOINT',
@@ -112,7 +112,7 @@ Openlit.init({
Add the following two lines to your application code:
```typescript
-import Openlit from "@openlit/ts"
+import Openlit from "openlit"
Openlit.init()
```
diff --git a/sdk/typescript/package-lock.json b/sdk/typescript/package-lock.json
index 32d2ace6..b0761646 100644
--- a/sdk/typescript/package-lock.json
+++ b/sdk/typescript/package-lock.json
@@ -1,11 +1,11 @@
{
- "name": "@openlit/ts",
+ "name": "openlit",
"version": "1.0.0",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
- "name": "@openlit/ts",
+ "name": "openlit",
"version": "1.0.0",
"license": "ISC",
"dependencies": {
diff --git a/sdk/typescript/package.json b/sdk/typescript/package.json
index 5257e9c2..62fca359 100644
--- a/sdk/typescript/package.json
+++ b/sdk/typescript/package.json
@@ -1,5 +1,5 @@
{
- "name": "@openlit/ts",
+ "name": "openlit",
"version": "1.0.0",
"homepage": "https://github.com/openlit/openlit#readme",
"bugs": {