NeuralCodeDOCS
Developer reference

Data model

The core types that flow between the backend and the UI — and that are persisted in your local store.json.

Project#

FieldMeaning
pathAbsolute repo path (the unique key).
nameDisplay name (the folder name).
base_branchThe repo's base branch.

Workspace#

FieldMeaning
idUnique id (the agent session is agent:<id>).
name / project_pathTask name and owning project.
worktree_path / branch / base_branchThe isolated checkout, its branch, and what it merges into.
statusidle · running · done · error · merged · archived.
messagesThe chat history (ChatMessage[]).
startedWhether the agent has run at least once.
review / checks_passed / checks_outputThe self-review text and test results.

ChatMessage & ChatStep#

TypeFields
ChatMessagerole (user · agent · system), text, ts, steps, duration_ms.
ChatStepkind (text · tool), text, tool, detail — one step of an agent turn.

DiffResult & FileChange#

TypeFields
DiffResultpatch (unified diff), files (FileChange[]).
FileChangepath, status (added · modified · deleted · renamed), added, removed.

Settings#

FieldMeaning
modelThe Claude model id (see Models).
permission_modeskip · acceptEdits · plan · default.
thinkingoff · high · xhigh · max.
budget_usd / budget_periodThe spend budget and its window.
auto_reviewWhether self-review & checks run after each run.
branch_strategysimple · conventional.

UsageRecord#

FieldMeaning
ts / modelTimestamp and model used.
cost_usdDollar cost of the run.
input / output / cache_read / cache_creation tokensToken breakdown.
workspace_id / project_pathWhere the usage came from.

Other types#

TypeFields
Commandid, name, description, prompt, kind (command · skill).
Issuenumber, title, body, url, labels, state.
GithubAccount / GoogleAccountThe signed-in profile (login/name/avatar, or email/name/picture).
DepStatusgit, claude booleans plus version strings.
Note
All of this is persisted locally in store.json — see How it's built → storage.