Add a Neru CLI command or flag: cobra command in internal/cli, IPC handler in internal/app/ipcctrl, service/mode work behind it, man pages, and docs/reference/cli.md. Use when adding or changing user-facing commands, subcommands, or flags. Not for config.toml options.
中文简介正在准备中。当前显示原文说明。
实测评分 未实测
查看安装方法安装前可以查看交给 AI 代理的指令内容。
Neru is a daemon plus a thin CLI. Almost every command serializes an IPC
request to the running daemon over its per-user Unix socket or Windows named
pipe. A new command therefore touches three layers plus docs.
Skipping the IPC layer and calling app code directly from internal/cli is
wrong even when it compiles.
internal/cli/<name>.go, registered in an init()
like its siblings. Mode-shaped commands (hints/grid/scroll variants) go
through BuildModeCommand(ModeConfig{...}) in command_builders.go instead
of hand-rolling cobra. Look at hints.go first. Long help text follows the
house style: prose, then flag explanations, then an Examples: block.internal/adapter/ipc), so you only add
an action string. Keep the wire shape in one place and reuse existing
request helpers in internal/cli/cliutil.internal/app/ipcctrl. Handlers register into
Controller.Handlers via the sub-controller for their family
(lifecycle, modes, actions, info, overlay, scroll, …). Extend
the matching RegisterHandlers, and don't add a case to the controller.internal/app/services/* or a mode, never in
the handler. Handlers parse, delegate, and shape the ipc.Response.just genman (backed by ./cmd/genman).
Cobra metadata is the source, so if the man page reads wrong, fix the
command's Short/Long, not the output.docs/reference/cli.md. It is the single home for CLI reference
facts.docs/reference/ipc.md. internal/architecture/ipc_reference_test.go
fails while the table and the commands the daemon answers differ.just genschema.
internal/architecture/ipc_schema_test.go fails while
schemas/ipc.schema.json is out of date.A flag on a mode command (hints --action left_click) is not registered by
hand. It is one entry in the descriptor table in internal/domain/modecmd,
carrying its own parse, its own render, and the modes that accept it. That
entry is what offers the flag on the command line, what the daemon and the
config validator read it with, and what writes its row in the reference.
After adding, removing or re-wording one, run just genflagref to rewrite the
generated region of docs/reference/cli.md. An architecture test
(internal/architecture/mode_flag_contract_test.go) fails while a descriptor
is unregistered or missing from that region, and while a mode command offers a
flag the table never declared.
internal/cli/cli_test.go / *_internal_test.go.internal/app/ipcctrl/*_test.go with port mocks from
internal/ports/mocks. Assert the response shape and that the right
service call happened, not internals.derrors.CodeNotSupported, and a
contract test pins that (root AGENTS.md, "Hard rules").just build
./bin/neru <command> --help # against a running daemon: ./bin/neru launch
just genman
Then the standard pre-commit gate from AGENTS.md.
还没有评价。欢迎分享你的使用感受。
无需登录即可发表。欢迎分享使用感受、提问，或说明在哪些环境下无法运行。
还没有评论。来写第一条吧。
Add or change a Neru config.toml option end to end: struct field, shared and platform defaults, validation, examples, docs, and hot-reload behavior. Use whenever a change adds, renames, or removes a key in the TOML config schema. Not for theme palette entries or CLI flags.
中文简介正在准备中。当前显示原文说明。
Implement or stub Neru functionality for a specific OS/backend: port contract, build-tagged file slots, factory wiring, CodeNotSupported stubs, capability matrix, contract tests, and the docs ownership table. Use for any change under internal/adapter/platform or any *_darwin/_linux/_windows file. Not for pure-Go domain logic.
中文简介正在准备中。当前显示原文说明。
Answer a Neru user's question about what Neru does, which command, flag, or config key does a thing, why something does not work, or what to try next, from the help, man pages, and docs of their installed version rather than from memory. Routes config work to neru-setup-config. Use when a Neru user asks what Neru can do, how to do something with it, which command to run, why hints or a hotkey do nothing, or which skill to use.
中文简介正在准备中。当前显示原文说明。
Help a Neru user build a tool on top of Neru, such as a status bar, a launcher, voice control, a companion UI, automation from another hotkey tool, a Go program, or a client for the IPC socket in another language. Picks the interface, checks the installed version has it, reads the contract from that version's docs, and runs the result against the live daemon. Routes config and hooks work to neru-setup-config. Use when a Neru user wants to script Neru, read its state, follow its events, drive it from another program, or write code against its CLI, socket, or Go client.
中文简介正在准备中。当前显示原文说明。
Commit working changes and open a Neru pull request the maintainer's way: conventional commit subjects, a PR title written for the changelog, the just ci gate, and the repo PR template filled honestly. Use when asked to commit, create a PR, open a pull request, or ship finished work in this repo.
中文简介正在准备中。当前显示原文说明。
File a Neru bug report or feature request that matches the repo's issue forms: duplicate check first, every required field filled with real diagnostics, correct labels. Use when asked to open, file, or draft a GitHub issue for Neru. Not for pull requests.
中文简介正在准备中。当前显示原文说明。