electric
1
总安装量
1
周安装量
#44588
全站排名
安装命令
npx skills add https://github.com/olegakbarov/openai-hackathon --skill electric
Agent 安装分布
amp
1
opencode
1
kimi-cli
1
codex
1
github-copilot
1
claude-code
1
Skill 文档
ElectricSQL + TanStack DB
Overview
Use this skill to implement the Electric + TanStack DB stack for local-first apps. Focus on secure proxying, shape configuration, optimistic write flow, and live queries. The full guide is in references/electric-docs.md.
Golden path
- Create a project and run migrations.
- Add an Electric proxy route on the server and inject SOURCE_ID/SECRET.
- Create Electric collections on the client with
electricCollectionOptions. - Implement write handlers that call the API and return a Postgres txid.
- Use live queries for reads and joins.
- Validate performance, auth, and deployment setup.
Security rules (always)
- Never expose SOURCE_SECRET to the browser.
- Do not call Electric directly from production clients.
- Define shapes server-side; do not allow client-defined tables or WHERE clauses.
Write path contract
- Optimistic mutation in TanStack DB.
- API writes to Postgres and returns txid.
- Client awaits txid on the Electric stream before dropping optimistic state.
Shape rules
- Shapes are single-table with optional where/columns.
- Include primary key when using columns.
- Shapes are immutable per subscription; create a new collection for dynamic shapes.
Troubleshooting
- UI flicker usually means missing txid handshake.
- Slow shapes in dev can be HTTP/1.1 limits; use HTTP/2 proxy or Electric Cloud.
- Ensure proxy forwards Electric query params and preserves headers.
References
references/electric-docs.mdcontains the full documentation snapshot.