Skip to content

Commit 4ff1040

Browse files
authored
Merge pull request #60 from SentienceAPI/renamed
renamed npm package name
2 parents 74ea7d5 + 032af70 commit 4ff1040

4 files changed

Lines changed: 26 additions & 20 deletions

File tree

.github/workflows/release.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,11 +73,11 @@ jobs:
7373
tag_name: v${{ steps.version.outputs.version }}
7474
name: Release v${{ steps.version.outputs.version }}
7575
body: |
76-
Release v${{ steps.version.outputs.version }} of sentience-ts
77-
76+
Release v${{ steps.version.outputs.version }} of sentienceapi
77+
7878
## Installation
7979
```bash
80-
npm install sentience-ts@${{ steps.version.outputs.version }}
80+
npm install sentienceapi@${{ steps.version.outputs.version }}
8181
```
8282
draft: false
8383
prerelease: false

README.md

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,19 @@ The SDK is open under ELv2; the core semantic geometry and reliability logic run
55
## Installation
66

77
```bash
8-
npm install
9-
npm run build
8+
# Install from npm
9+
npm install sentienceapi
1010

1111
# Install Playwright browsers (required)
1212
npx playwright install chromium
1313
```
1414

15+
**For local development:**
16+
```bash
17+
npm install
18+
npm run build
19+
```
20+
1521
## Quick Start: Choose Your Abstraction Level
1622

1723
Sentience SDK offers **4 levels of abstraction** - choose based on your needs:
@@ -21,7 +27,7 @@ Sentience SDK offers **4 levels of abstraction** - choose based on your needs:
2127
Complete automation with natural conversation. Just describe what you want, and the agent plans and executes everything:
2228

2329
```typescript
24-
import { SentienceBrowser, ConversationalAgent, OpenAIProvider } from 'sentience-ts';
30+
import { SentienceBrowser, ConversationalAgent, OpenAIProvider } from 'sentienceapi';
2531

2632
const browser = await SentienceBrowser.create({ apiKey: process.env.SENTIENCE_API_KEY });
2733
const llm = new OpenAIProvider(process.env.OPENAI_API_KEY!, 'gpt-4o');
@@ -52,7 +58,7 @@ await browser.close();
5258
Zero coding knowledge needed. Just write what you want in plain English:
5359

5460
```typescript
55-
import { SentienceBrowser, SentienceAgent, OpenAIProvider } from 'sentience-ts';
61+
import { SentienceBrowser, SentienceAgent, OpenAIProvider } from 'sentienceapi';
5662

5763
const browser = await SentienceBrowser.create({ apiKey: process.env.SENTIENCE_API_KEY });
5864
const llm = new OpenAIProvider(process.env.OPENAI_API_KEY!, 'gpt-4o-mini');
@@ -80,7 +86,7 @@ await browser.close();
8086
Full control with semantic selectors. For technical users who want precision:
8187

8288
```typescript
83-
import { SentienceBrowser, snapshot, find, click, typeText, press } from 'sentience-ts';
89+
import { SentienceBrowser, snapshot, find, click, typeText, press } from 'sentienceapi';
8490

8591
const browser = await SentienceBrowser.create({ apiKey: process.env.SENTIENCE_API_KEY });
8692
await browser.getPage().goto('https://www.amazon.com');
@@ -136,7 +142,7 @@ import {
136142
OpenAIProvider,
137143
Tracer,
138144
JsonlTraceSink
139-
} from 'sentience-ts';
145+
} from 'sentienceapi';
140146
import { randomUUID } from 'crypto';
141147

142148
const browser = await SentienceBrowser.create({ apiKey: process.env.SENTIENCE_API_KEY });
@@ -222,7 +228,7 @@ console.log(`Total tokens: ${totalTokens}`);
222228
You can also use the tracer directly for custom workflows:
223229

224230
```typescript
225-
import { Tracer, JsonlTraceSink } from 'sentience-ts';
231+
import { Tracer, JsonlTraceSink } from 'sentienceapi';
226232
import { randomUUID } from 'crypto';
227233

228234
const runId = randomUUID();
@@ -258,7 +264,7 @@ Traces are **100% compatible** with Python SDK traces - use the same tools to an
258264
### Google Search (6 lines of code)
259265

260266
```typescript
261-
import { SentienceBrowser, SentienceAgent, OpenAIProvider } from 'sentience-ts';
267+
import { SentienceBrowser, SentienceAgent, OpenAIProvider } from 'sentienceapi';
262268

263269
const browser = await SentienceBrowser.create({ apiKey: apiKey });
264270
const llm = new OpenAIProvider(openaiKey, 'gpt-4o-mini');
@@ -278,7 +284,7 @@ await browser.close();
278284
### Using Anthropic Claude Instead of GPT
279285

280286
```typescript
281-
import { SentienceAgent, AnthropicProvider } from 'sentience-ts';
287+
import { SentienceAgent, AnthropicProvider } from 'sentienceapi';
282288

283289
// Swap OpenAI for Anthropic - same API!
284290
const llm = new AnthropicProvider(
@@ -315,7 +321,7 @@ await agent.act("Click the 'Add to Cart' button");
315321

316322
```bash
317323
# Install core SDK
318-
npm install sentience-ts
324+
npm install sentienceapi
319325

320326
# Install LLM provider (choose one or both)
321327
npm install openai # For GPT-4, GPT-4o, GPT-4o-mini
@@ -747,7 +753,7 @@ const browser = new SentienceBrowser();
747753
await browser.start();
748754

749755
// With agent
750-
import { SentienceAgent, OpenAIProvider } from 'sentience-ts';
756+
import { SentienceAgent, OpenAIProvider } from 'sentienceapi';
751757

752758
const browser = new SentienceBrowser(
753759
'your-api-key',
@@ -784,7 +790,7 @@ Inject pre-recorded authentication sessions (cookies + localStorage) to start yo
784790

785791
```typescript
786792
// Workflow 1: Inject pre-recorded session from file
787-
import { SentienceBrowser, saveStorageState } from 'sentience-ts';
793+
import { SentienceBrowser, saveStorageState } from 'sentienceapi';
788794

789795
// Save session after manual login
790796
const browser = new SentienceBrowser();

package-lock.json

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "sentience-ts",
2+
"name": "sentienceapi",
33
"version": "0.90.0",
44
"description": "TypeScript SDK for Sentience AI Agent Browser Automation",
55
"main": "dist/index.js",

0 commit comments

Comments
 (0)