- ClayJS
- Start here
- Pick your problems
Pick your problems
A short list of what you might be building. Pick the ones that apply and read only those pages.
Go through this page and pick out the problems you are solving with the thing you are making. Is it A, B and C? Is it D and G? Write down those letters, then read those pages. Ignore everything else for now. You only climb as high as your needs take you. If a static HTML file already does the job, stop.
A. Host and share a file#
- Use this when: you have an HTML file and want other people to open it at a link.
- Skip this when: the file stays on your computer.
- Read: import a file, share it
B. Edit in the page#
- Use this when: people should change text or checkboxes in the page, and the change must be saved in the file.
- Skip this when: the file is only read, or edited in code.
- Read: Quick start
C. Sync between tabs and people#
- Use this when: the file may be open in more than one tab, on more than one device, or by more than one person.
- Skip this when: the file is only ever open in one place.
- Read: Live sync
D. Let your own agent edit it#
- Use this when: you want Claude Code, Cursor or another MCP client to read and edit your documents on Hyperclay.
- Skip this when: nobody uses an agent on the file.
- Read: Edit with AI agents
E. Rich text, media or a CMS#
- Use this when: people need formatted text, images or uploads, or a sidebar of fields for page content.
- Skip this when: plain text and static markup are enough.
- Read: Editing components, CMS
F. Reactive records#
- Use this when: the page has totals, counts, filtered lists, or forms that add records.
- Skip this when: no value depends on another value.
- Read: SapJS guide
G. A visitor view and SEO#
- Use this when: visitors should see the page without edit controls, or you want to set its search and link preview text.
- Skip this when: everyone gets one view and previews do not matter yet.
- Read: Edit mode and view mode, Menu and SEO settings
H. Structured data as JSON#
- Use this when: a tool or agent needs to read the page’s fields as JSON, or update them.
- Skip this when: nothing outside the page reads its data.
- Read: data plugin
The complete references stay available: ClayJS guide, SapJS guide.