xspace-AI docs
nirholas / xspace-AI

xspace-AI

AI agents that join, listen, and speak in X/Twitter Spaces — TypeScript SDK plus server, dashboard, and voice pipeline.

v0.1.0SEE LICENSE IN LICENSETypeScript
npm install

What it does

Capabilities documented in this repository.

What is this

See the full documentation for details.

Features

See the full documentation for details.

Requirements

See the full documentation for details.

Deploy

See the full documentation for details.

Documentation

See the full documentation for details.

Project Structure

See the full documentation for details.

Get started

Install it, then run your first command.

npm install
CommandRuns
npm run buildturbo build
npm run devnpx tsx watch packages/server/src/index.ts
npm run startnode dist/server/index.js
npm run lintnpx eslint src/
npm run typechecknpx tsc --noEmit && npx tsc -p tsconfig.client.json --noEmit
npm run testcd packages/core && npx --no-install vitest run

Read the full getting started guide

Examples

Taken directly from this repository's documentation.

node packages/cli/bin/xspace-agent join https://x.com/i/spaces/YOUR_SPACE_ID --provider openai
git clone https://github.com/nirholas/xspace-AI.git
cd xspace-AI
pnpm install
pnpm build
# .env
X_AUTH_TOKEN=your_x_auth_token
X_CT0=your_x_ct0_cookie
OPENAI_API_KEY=sk-...

More examples

Reference