From 7ed99d73478540c80aace1f18b7b007875c13baa Mon Sep 17 00:00:00 2001 From: hzhang Date: Sat, 16 May 2026 17:50:00 +0100 Subject: [PATCH] =?UTF-8?q?docs:=20refresh=20README=20=E2=80=94=20accuracy?= =?UTF-8?q?=20pass=20+=20HarborForge=20platform=20context?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Verified against current code; fixed stale/inaccurate sections and documented previously-undocumented features/flags/endpoints. Added a "Part of the HarborForge platform" reference and role/port. Co-Authored-By: Claude Opus 4.7 (1M context) --- README.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 2bcf630..4b57790 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # HarborForge.Cli -`HarborForge.Cli` is the Go-based `hf` binary for HarborForge. +`HarborForge.Cli` is the Go-based `hf` command-line client for HarborForge. + +Part of the [HarborForge](../README.md) platform. `hf` is a thin, scriptable client over the `HarborForge.Backend` REST API (default `http://127.0.0.1:8000`). It is permission-aware (command visibility derives from the caller's backend permissions) and supports both automatic secret resolution (padded-cell mode) and explicit `--token` auth (manual mode). ## Build @@ -205,14 +207,15 @@ There is not yet a finer-grained exit-code taxonomy; callers should currently tr - Top-level and group/leaf help rendering (`--help` / `--help-brief`) - Permission-aware command visibility via `/auth/me/permissions` - Detailed leaf help text for all commands, with padded-cell/manual auth flag differences -- Nested help coverage for `config`, `monitor server`, and `monitor api-key` subtrees +- Nested help coverage for `config`, `monitor server`, `monitor api-key`, and `proposal essential` subtrees - `(not permitted)` rendering for unauthorized commands **Core commands:** - `hf version`, `hf health`, `hf config` (show / `--url` / `--acc-mgr-token`) +- `hf update-discord-id [discord-id]` — top-level convenience command **Resource commands (all implemented with list/get/create/update/delete + special actions):** -- `hf user` — create, list, get, update, activate, deactivate, delete +- `hf user` — create, list, get, update, activate, deactivate, delete, reset-apikey - `hf role` — list, get, create, update, delete, set-permissions, add-permissions, remove-permissions - `hf permission` — list - `hf project` — list, get, create, update, delete, members, add-member, remove-member @@ -220,7 +223,9 @@ There is not yet a finer-grained exit-code taxonomy; callers should currently tr - `hf task` — list, get, create, update, transition, take, delete, search - `hf meeting` — list, get, create, update, attend, delete - `hf support` — list, get, create, update, take, transition, delete -- `hf propose` — list, get, create, update, accept, reject, reopen +- `hf proposal` (alias: `hf propose`) — list, get, create, update, accept, reject, reopen + - `hf proposal essential` — list, create, update, delete +- `hf calendar` — schedule, show, edit, cancel, date-list, plan-schedule, plan-list, plan-edit, plan-cancel - `hf comment` — add, list - `hf worklog` — add, list - `hf monitor` — overview, server (list/get/create/delete), api-key (generate/revoke) @@ -229,4 +234,4 @@ There is not yet a finer-grained exit-code taxonomy; callers should currently tr - Backend code-based endpoint support (some commands still use id-based API routes) - Release automation beyond local `make release` packaging (checksums / archives / CI publishing) -- Integration tests +- Broader test coverage (unit tests exist for the calendar and proposal commands; end-to-end coverage is still partial)