-
Notifications
You must be signed in to change notification settings - Fork 0
Backend API
JumpStart Wiki Bot edited this page Aug 8, 2026
·
1 revision
All methods are on *App and exposed through Wails. Frontend imports them via frontend/src/api.js.
Return values and errors cross the binding boundary as promises. Prefer returning structured types over free-form strings when the UI must branch.
| Method | Notes |
|---|---|
GetProjects |
Full project list |
SaveProject |
Insert or replace by ID; tracks create vs update |
DeleteProject |
Also deletes codectx + chats |
SetProjectFavorite |
Targeted write |
StartProcess / StopProcess
|
Single process |
StartAll / StopAll
|
Per project; StartAll returns error strings |
GetStatus / GetLogs
|
From procman |
GetUsage |
System + per-PID via sysinfo |
GetPortMap |
Aggregate listening ports for running procs |
| Method | Notes |
|---|---|
UpdateTasks |
Replaces task slice; diffs for analytics |
UpdateSprints |
Reindexes Order from slice position |
| Method | Notes |
|---|---|
DetectProcesses |
detect.Scan |
ReadEnvFile |
dotenv → map |
PickDirectory / PickConfigFile
|
Native dialogs |
GetImportPath, ImportConfig, ImportConfigText, ImportConfigFile, ReadConfigFile
|
Import flows |
GetDependencies, InstallDeps
|
InstallDeps returns synthetic proc ID |
| Method | Notes |
|---|---|
OllamaListModels |
|
OllamaEnrichTask |
Task fill |
OllamaChat |
Stateless chat helper |
OllamaGenerateCommitMessage |
Needs project root |
GenerateProjectDescription |
|
BuildCodeContext / GetCodeContextStatus / ClearCodeContext / SearchCodeContext
|
|
ListChats / GetChat / NewChat / RenameChat / DeleteChat
|
|
SendChatMessage |
Persists turns; may attach retrieved sources |
| Method | Notes |
|---|---|
GitStatus, GitInit, GitFetch, GitPull, GitPush, GitCommit
|
Wrapped with gitOp analytics |
GitAddRemote, branch CRUD, GitGraphLog, GitDiff, GitListStashes
|
|
SaveGitToken / HasGitToken / DeleteGitToken
|
Keychain |
CreateRelease |
internal/release |
DockerInfo, ComposeUp, ComposeDown, ListContainers, ListImages, ListVolumes, StartContainer, StopContainer, RemoveContainer — docker actions use dockerOp for analytics.
| Method | Notes |
|---|---|
DetectScripts |
|
RunScript / StopScriptRun / ListScriptRuns / ListProcessScriptRuns / GetScriptRunStatus
|
Run IDs share log/exit events with procman |
DetectTestConfig / RunTests
|
| Method | Notes |
|---|---|
GetAppVersion |
Trims leading v for display |
CheckForUpdate / InstallUpdate / RestartApp
|
Channel from frontend wrapper |
GetRemoteBanner |
|
GetAboutInfo |
Version, build date, vendor |
OpenInFileManager / OpenInTerminal
|
|
GetContributeInfo / SubmitIssue / ListRepoIssues / CollectDiagnostics
|
|
GetAnalyticsSettings / SetAnalyticsEnabled
|
|
TrackEvent / TrackEventOnce / TrackModelSelected / SetUpdateChannel
|
Used by frontend/src/analytics.js
|
SetNativeTheme |
light/dark/system + macOS appearance |
- Add
func (a *App) Foo(...)inapp.goor a dedicated*_api.go. - Put domain logic in
internal/<pkg>when non-trivial. - Add analytics if it is a user-facing action (bounded props only).
- Run
wails dev(or build) to regeneratewailsjs. - Export from
frontend/src/api.js. - Call from UI; never import
wailsjs/go/main/Appin feature files ifapi.jsalready re-exports it.