Skip to content
socai docs

Development

The repository contains a Rust core, Rust CLI and terminal interface, a Tauri desktop app, and the Astro website that serves these docs.

Clone and inspect the project

Section titled “Clone and inspect the project”
Terminal window
git clone https://github.com/socai-io/socai.git
cd socai

Read AGENTS.md before changing implementation code and DEVELOPMENT.md for the maintained local workflows.

Rust workspace

Section titled “Rust workspace”
Terminal window
cargo build
cargo test
cargo run -p socai-cli -- xhs search "运营爆款思路" --num-notes 10

Desktop app

Section titled “Desktop app”
Terminal window
cd app
pnpm install
pnpm exec tauri dev

The frontend is Vite and vanilla TypeScript; the shell is Tauri 2.

Website and docs

Section titled “Website and docs”
Terminal window
cd site
pnpm install
pnpm dev
pnpm build

The marketing pages and Starlight documentation build together into site/dist/. Documentation sources live under site/src/content/docs/docs/, which maps them to socai.io/docs/*.

Contribute documentation

Section titled “Contribute documentation”

Each docs page includes an Edit page link to its source file on GitHub. Keep user-facing guides focused on supported behavior and run the full site build before opening a pull request.