zhi/HarborForge.Cli
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: refresh README — accuracy pass + HarborForge platform context

Browse Source 
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) <noreply@anthropic.com>
This commit is contained in:
h z
2026-05-16 17:50:00 +01:00
parent f1ebc52cca
commit 7ed99d7347
1 changed files with 10 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@@ -1,6 +1,8 @@
# HarborForge.Cli # 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 ## 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`) - Top-level and group/leaf help rendering (`--help` / `--help-brief`)
- Permission-aware command visibility via `/auth/me/permissions` - Permission-aware command visibility via `/auth/me/permissions`
- Detailed leaf help text for all commands, with padded-cell/manual auth flag differences - 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 - `(not permitted)` rendering for unauthorized commands
**Core commands:** **Core commands:**
- `hf version`, `hf health`, `hf config` (show / `--url` / `--acc-mgr-token`) - `hf version`, `hf health`, `hf config` (show / `--url` / `--acc-mgr-token`)
- `hf update-discord-id <username> [discord-id]` — top-level convenience command
**Resource commands (all implemented with list/get/create/update/delete + special actions):** **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 role` — list, get, create, update, delete, set-permissions, add-permissions, remove-permissions
- `hf permission` — list - `hf permission` — list
- `hf project` — list, get, create, update, delete, members, add-member, remove-member - `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 task` — list, get, create, update, transition, take, delete, search
- `hf meeting` — list, get, create, update, attend, delete - `hf meeting` — list, get, create, update, attend, delete
- `hf support` — list, get, create, update, take, transition, 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 comment` — add, list
- `hf worklog` — add, list - `hf worklog` — add, list
- `hf monitor` — overview, server (list/get/create/delete), api-key (generate/revoke) - `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) - Backend code-based endpoint support (some commands still use id-based API routes)
- Release automation beyond local `make release` packaging (checksums / archives / CI publishing) - 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)