How runmedev/runme works
Runme turns Markdown code cells into runnable, stateful workflows. A user discovers or inspects cells with the CLI, then runs a named task; project and document handling provide task context, and a runner executes commands while retaining session environment. The repository also exposes parser, project, notebook, and runner services, plus an agent server with streaming and optional authentication. Harbor provides a separate command-execution interface. The main workflow is documented in the README; some links are supported only by source-index references, so unsampled behavior is not inferred.
Main entry points: service.go Runner service · server.go Local service command · cmd Runme CLI · client.go Runner clients
Components 22
CLI workflow
- Runme CLI
cmd
Documents and projects
- Project and tasks
project/project.go - Markdown parser
document/parser.go - Notebook editor
document/editor/editor.go
Execution runtime
- Runner clients
runner/client/client.go - Remote runner
runner/client/client_remote.go - Runner service
runner/service.go - Execution sessions
runner/session.go - Command runtime
command/factory.go
Services and agent
- Local service command
cmd/server.go - gRPC server
internal/server/server.go - Parser service
document/editor/editorservice/service.go - Notebook service
notebook/service.go - Agent application
pkg/agent/application/app.go - Agent server
pkg/agent/server/server.go - WebSocket streams
pkg/agent/runme/stream/handler.go - Agent RPC contracts
api/proto/agent/v1/service.proto - Parser RPC contracts
api/gen/proto/ts/runme/parser/v1/parser_pb.js - Agent notebook contracts
api/gen/proto/es/agent/tools/v1/notebooks_pb.js
Harbor execution
- Harbor server
internal/harbor/server.go - Harbor integration
integrations/harbor/src/runme_harbor/runme_agents.py
Other components
- Runbook user
Connections 18
- Runbook user → Runme CLI: runs or lists
README.md - Runme CLI → Project and tasks: selects tasks
README.md - Runme CLI → Runner clients: runs task
- Runner clients → Project and tasks: uses project
runner/client/client.go - Runner clients → Markdown parser: uses document
runner/client/client.go - Remote runner → Runner service: RPC requests
runner/client/client_remote.go - Runner service → Execution sessions: manages sessions
runner/service.go - Runner service → Command runtime: builds commands
runner/service.go - Local service command → Parser service: registers service
cmd/server.go - Local service command → Notebook service: registers service
cmd/server.go - Local service command → Runner service: registers runner
cmd/server.go - gRPC server → Parser service: hosts services
- Parser service → Notebook editor: deserializes notebook
document/editor/editorservice/service.go - Agent application → Agent server: configures server
- Agent server → WebSocket streams: registers streams
pkg/agent/server/server.go - Agent server → Agent RPC contracts: serves API
- Harbor server → Command runtime: builds commands
internal/harbor/server.go - Harbor integration → Harbor server: integrates with