Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Make agentop and the installer depend only on documented contracts

オープン
#1,500 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
40/100
issue の種類
リファクタリング
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
go, yaml

調査の方向性

Start with cmd/agentop/local_endpoint.go and the listed agentop callers, then read docs/session-api.md, docs/README.md, the proxy handlers and scripts/install.sh. Add contract fixtures shared by agentop decoders and proxy handlers, and centralize the proxy process identity as the issue describes. Done means agentop no longer decodes config.Config, the endpoints and summary view are documented and checked for drift, and the process name is defined in one constant.

索引モデルが issue の本文から書いたものです。

説明

enhancement laptop

Part of #1437 (assessment: laptop data plane on Praxis) · prep work, useful to Cortex on its own

Status: there is no shipped Cortex–Praxis integration today (the paused cmd/cortex-praxis converter is not one), and the interim path is not decided (LLM traffic to praxis-ai as an inference server, or all traffic through Praxis via #1491). Nothing here depends on that choice: each item is useful to Cortex now, and would make a possible move to Praxis easier whichever path is taken.

Problem

If the data plane ever changes, to Praxis or anything else, agentop and the installer should not notice. Today they depend on Go proxy internals beyond the documented session API:

  • the full Go config struct;
  • the reload and stats endpoints' exact JSON;
  • the proxy's binary name.

Any change to those internals, or a different proxy build, breaks agentop exec, server, pricing, doctor, service, setup, uninstall, claude-code enable and the TUI's edit flows without warning. Some drift is already visible: edit/configmap.go:319 names a /reload/status field, last_success_unix, that doesn't exist.

What Cortex does today

agentop exec decodes /config into the whole Go config.Config (local_endpoint.go:289).

  • It uses three fields: listener.forward_proxy_addr, tls_bridge.mode and tls_bridge.ca_dir (:294).
  • The risk is the decode itself: json.Unmarshal into the whole struct fails if any field's type changes in a newer proxy.
  • The helpers that read those fields (wantedFromLoaded, bridgeEnabled in cmd_claudecode.go) take *config.Config and are shared with claude-code enable, so the two can't drift. Narrowing exec means changing that shared signature too.
  • /config serves the resolved config (after presets), which exec relies on. docs/README.md:82 says it's "as written, not as resolved"; that sentence is wrong.

13 non-test agentop files import core/config. Most of them call config.Load on ~/.cortex/config.yaml (27 calls): a dependency on the YAML schema, not on /config. Fixing exec removes none of the 13 imports.

Stats and health endpoints agentop relies on are described only in prose, with no schema, no fixtures and no single page (docs/laptop-service.md, framework-architecture.md, docs/pricing.md):

view=summary is missing from the API reference. agentop sends it on every timeline fetch (apiclient/snapshot.go:32). It's described in cmd/agentop/README.md and in the server's own GET / index, but not in docs/session-api.md. Neither documents the response's view echo, which agentop uses to detect the summary.

The proxy is recognised by name in at least six places, not one:

  • agentop: isProxyComm; proxyRunning, which repeats the literal instead of calling it (setup_probe.go:230); ourProxy, which compares the path binDir/cortex (:210); foreignHolderLines (cmd_service.go:785)
  • install.sh: :710, and :722 for the pre-rename binary

Related hardcoded identity: about ten filepath.Join(binDir, "cortex") sites, setupBinaryNames, the service label io.rossoctl.cortex and cortex.service, and the pid file proxy.pid. The name check exists to catch a recycled pid in that pid file.

The proxy's command-line contract is not written down anywhere complete. agentop invokes --version (parsed for its last word and for " (cpex) "), --local --write-config, --local --supervise, --supervise --config <path> (launchd) and --config <path> (systemd). The test stub cortexStub covers only the first three; docs/laptop-service.md mentions some in prose.

Proposal

  1. agentop exec decodes only what it uses: a local struct instead of config.Config, with the shared claude-code helpers taking that struct too.
  2. Document the stats and health contract on one page: the JSON of /reload/status, /config (the fields agentop reads), /pricing/table, /tls-bridge/unread, /healthz, /readyz, the default ports, and view=summary with its echo. Add JSON fixtures that agentop's decoders and the proxy's handlers are both tested against. Fix the /config sentence in docs/README.md. Coordinate with #1497 item 5 and #1499 item 2: one schema-and-fixtures effort.
  3. One constant for the proxy's process name, and one for its binary filename, used by every check above; install.sh references the constant in a comment. Write down the full command-line contract, including the service-unit invocations.
  4. Label each config section data plane or control plane in docs/README.md's config table, with its reload rule. That tells any future data-plane build which sections it must honour.
  5. Hot-reload as a stated contract. agentop edits ~/.cortex/config.yaml and waits on /reload/status (edit/local.go; also edit/pluginwrite.go:113 for agentop server). Document that as the contract, rather than an implementation detail of core/reloader, including two caveats: tls_bridge edits report success without being applied, and last_success is compared against agentop's clock.

Design questions

  1. Should /config stay the source for exec, or should the session API expose the three values directly?
  2. Should the process-name check become an executable-path check? The pid file already exists; the name check is what catches a recycled pid.

Done when

  • agentop exec builds without decoding config.Config.
  • The stats and health endpoints and view=summary are documented on one page, with fixtures that fail on drift in either the proxy or agentop.
  • The proxy's process name and binary filename each appear in one constant, plus install.sh, which references them in a comment.

Evidence read at main @ e455a04 (2026-10-25); not built or run.

主要言語
Go
スター
21
フォーク
43
平均マージ
14時間 49分
マージ済み PR(30日)
236

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

rossoctl/cortex のほかの issue

rossoctl/cortex の issue をすべて見る

似ている issue

Go の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。