main ffa9a5e

Public API contract of the ermite forge: protobuf + generated Go

Read-only mirror. Development happens at git.bnema.dev; issues and pull requests are closed here.

import (
	"bnema.dev/ermite-api/gen/ermite"
	"bnema.dev/ermite-api/gen/ermite/ermiteconnect"
)
  • The server mounts the services under /-/api/. Errors are Connect codes.
  • No version number: the contract only changes in backward-compatible ways, and CI rejects breaking changes (buf breaking).
  • Tokens carry scopes only; presets such as cli or agent are a client concern.

Status: early development.

Services

Service Purpose
RepoService repositories and their settings
GitService refs, trees, blobs, commits and diffs
TokenService API tokens
MergeRequestService merge requests, comments, merge
IssueService issues, comments, owner moderation of public submissions
SessionService web sign-in links (owner only)
EventService live event stream, resumable
ServerService version, features, signing key, OIDC key rotation
RunService CI runs, jobs, logs, checks, runners
RunnerService used by CI runners to fetch and report jobs
SecretService, VariableService, EnvironmentService CI settings
ArtifactService CI artifacts, for people
JobArtifactService CI artifacts v4, for runners
TrustedKeyService SSH and OpenPGP keys commit signatures are checked against

Every RPC: docs/services.md.

Layout

  • proto/ermite/: one .proto per service, plus shared types.proto.
  • gen/ermite/: generated messages; gen/ermite/ermiteconnect/: Connect clients and handlers. Committed, never edited by hand.
buf generate

License

MIT. See LICENSE.

Keyboard shortcuts

Single-key shortcuts are on. ctrl k and esc work whatever this says.

ctrl k :
go to a section, branch, tag, file or repository
?
this list
j k
move the row cursor down / up
enter
open the row under the cursor; on Files, a directory opens or closes in place
↑ ↓ ← → home end
in the file tree (focus on a row): previous / next row, close / open a directory or go to its parent / first entry, first / last row. They never open a file
l h
on Files: open a directory or a file / close a directory or go up to its parent, then to the parent page. Elsewhere: into the side panel (on a merge request, its files) / back to the content; there j k move between its controls
g g G
first / last row
/
filter the list; on Files, find a file anywhere in the repository (esc clears, enter opens the best match)
b
switch branch or tag
g s g f g c g b g m g i g r g a
tabs: summary, files, commits, branches & tags, merge requests, issues, releases, actions (when available)
g h
home
w
wide mode: use the whole width of the screen, or not (remembered)
y
copy a permalink pinned to the commit
d u x
diff: split / unified / collapse or expand all
e E
diff: the whole file in view / every file, with the lines the hunks hide
n
merge request: next note in the diff
esc
close a dialog, leave a field

Branches 2

Tags 17

↑↓ moveenter openesc close