Getting Started
Quick Start
Go from zero to first successful command with the minimum useful tagged app surface.
Need the shortest path?
Use Quick Start when you want the smallest working route β scan β graph β run flow first.
Something feels off?
Inspect scan output, graph state, active route/context, and dispatch in a practical order.
Need the full surface?
Browse all runtime methods, hooks, extension points, and lifecycle APIs.
Start with one route, one context, and one or two meaningful controls. The easiest first success is a route plus an action or output on a page you already understand well.
This quick start is intentionally narrow. The goal is to prove the real local-first path on a website you control:
- tag a small page
- scan the DOM
- inspect the graph
- run a command
- confirm dispatch happened where you expected
1. Tag a small page
Start with a real route, one semantic context, one action, one field, and one output.
<section cinder-route="reports" data-cinder-path="/reports">
<div cinder-context="crop-prices">
<label for="crop-filter">Crop</label>
<select id="crop-filter" cinder-filter="crop">
<option value="soybean">Soybean</option>
<option value="paddy">Paddy</option>
</select>
<button cinder-action="search">Search</button>
<div tabindex="0" cinder-output="price">Price output</div>
</div>
</section>2. Initialize the runtime
import { Cinder } from 'usecinder';
await Cinder.init({
semantic: {
scanOnInit: false,
observeMutations: true,
},
ai: {
enabled: false,
mode: 'local',
endpoint: '',
apiKey: '',
},
});3. Scan the page and inspect structure
Once the tagged UI is in the DOM, scan it and inspect both scan output and graph state.
const scanResult = await Cinder.scan(document);
const graph = Cinder.graph();
console.log(scanResult);
console.log(graph);
console.log(graph.runtime.activeRouteId, graph.runtime.activeContextId);What to verify immediately
- the route node exists
- the context node exists
- the action / filter / output nodes exist
- active route and active context look reasonable
- there are no surprising warnings in
scanResult.warnings
4. Run a first command through the full runtime path
Use run() first so you can inspect intent, dispatch, and reflex output together.
const result = await Cinder.run('open reports', document);
console.log(result.intent, result.dispatch, result.reflex);Then try an output or action command:
await Cinder.run('show price', document);
await Cinder.run('search', document);5. Inspect the result honestly
Intent
Check whether local resolution selected the right route, action, field, filter, or output.
Dispatch
Confirm whether dispatch was handled through DOM behavior, bindings, or a composite multi-step flow.
Reflex
Use reflex output to see the user-facing result without guessing what the runtime thought happened.
6. Keep the first path tag-only if possible
For standard browser behavior, the best first proof is still tag-only:
- route navigation by anchor/path metadata
- field or filter updates by standard inputs
- actions by button or form submit behavior
- outputs by focus/reveal behavior
Add bindings, DOM adapters, or custom intent matchers only when the app needs them.
Good next commands to try
open reportssearchshow priceset crop to soybean
What to do if something looks wrong
- inspect
Cinder.lastScan() - inspect
Cinder.graph() - inspect
Cinder.resolve('your command') - inspect
await Cinder.dispatch(intent, document) - only then debug
run()as the full pipeline
Read Debugging for the full inspection path.
Next pages
Semantic Tags
Choose stable, meaningful tag keys that improve graph quality and local resolution.
Scanning the App
Learn when to scan, how mutation observation behaves, and what scan output is telling you.
Cinder.run
See the high-level full runtime method that resolves, dispatches, and returns reflex feedback in one call.
Continue reading
Previous: Installation
Install the browser SDK first, then add the server package only if you want hybrid fallback inference.
Next: Agent Onboarding
A single, agent-fetchable prompt that installs, tags, audits, verifies, and sets up a coding agent for Cinder end to end - the same pattern Neonβs own onboarding uses.