velt-js/agent-skills

velt-live-state-sync-best-practices

Velt Live State Sync implementation patterns and best practices for React, Next.js, and web applications. Use when adding real-time shared state, syncing data across clients, Redux store synchronization, or live variables. Triggers on any task involving Velt live state, useLiveState, useSetLiveStateData, useLiveStateData, useLiveStateSyncUtils, createLiveStateMiddleware, getLiveStateSyncElement, live state broadcast API, real-time collaborative state, or building shared-state features — even if…

First seen Jun 9, 2026

Installation

$ npx skills add velt-js/agent-skills --skill velt-live-state-sync-best-practices

Summary

  • Velt Live State Sync implementation patterns and best practices for React, Next.js, and web applications.
  • Use when adding real-time shared state, syncing data across clients, Redux store synchronization, or live variables.
  • Triggers on any task involving Velt live state, useLiveState, useSetLiveStateData, useLiveStateData, useLiveStateSyncUtils, createLiveStateMiddleware, getLiveStateSyncElement, live state broadcast API, real-time collaborative state, or building shared-state features — even if the user doesn't explicitly say 'live state sync'.

Similar popular skills

Related neighbors and high-traction skills in the same topics — useful to compare before installing.

Also in this package

Other skills from velt-js/agent-skills · top by installs.

npx skills add velt-js/agent-skills

Browse all from velt-js/agent-skills

More details

Agent compatibility

Declared targets from SKILL.md / docs. Unmarked agents are not listed — the skill may still install via the CLI.

Claude Code Not declared
Cursor Not declared
Codex Not declared
GitHub Copilot Not declared
Windsurf Not declared
Gemini CLI Not declared
Cline Not declared
OpenCode Not declared

Repository health

Stars 1
License MIT
Default branch main
Open issues 7
Status Active

Skill metadata

Parsed from SKILL.md frontmatter.

Version1.0.0
LicenseMIT
More metadata
author
velt
version
1.0.0

Package contents

Files included with this skill beyond the listing page.

  • skill md SKILL.md 2,208 B
  • docs SUMMARY.md 595 B

History

  1. First seen on skills.sh
  2. First recorded snapshot · 7 installs

SKILL.md

Velt Live State Sync Best Practices

Comprehensive guide for implementing Velt's Live State Sync API — real-time shared state across clients with sub-10ms latency, offline support, and Redux middleware integration. Contains 14 rules across 6 categories.

When to Apply

Reference these guidelines when:

  • Adding real-time shared state (counters, selections, cursors, tool modes) to a collaborative app
  • Using useLiveState for useState-like shared state
  • Using useSetLiveStateData / useLiveStateData for separated read/write patterns
  • Working with the LiveStateSyncElement for observable subscriptions or promise-based fetches
  • Integrating Redux with createLiveStateMiddleware for full store sync
  • Broadcasting state updates from your server via the REST API
  • Monitoring connection state for offline/online indicators

Rule Categories by Priority

Priority Category Impact Prefix
1 Core CRITICAL core-
2 Hooks CRITICAL hooks-
3 Element HIGH element-
4 Redux HIGH redux-
5 API MEDIUM api-
6 Patterns MEDIUM patterns-

Prerequisites

Live State Sync requires VeltProvider with authProvider wrapping your app and a documentId set to scope state. No additional packages beyond @veltdev/react are needed.

Compiled Documents

  • AGENTS.md — Compressed index of all rules with file paths (start here)
  • AGENTS.full.md — Full verbose guide with all rules expanded inline