Add CLI to system PATH during setup across all supported operating systems #23

New issue

Closed

opened 2026-09-18 17:32:09 +00:00 by gabogg · 1 comment

gabogg commented

2026-09-18 17:32:09 +00:00

Owner

Need Statement

Currently, executing hikctl requires operators to navigate directly into the installation directory and reference the script relatively (e.g., .\hikctl.cmd or ./hikctl) or supply full absolute paths. Running hikctl setup should automatically register hikctl onto the system PATH so it is globally invocable from any shell or directory.

Rationale & Benefits

Operator Ergonomics & Speed: System administrators can run operational commands (hikctl status, hikctl doctor, hikctl logs, hikctl service restart) from anywhere without having to locate or cd into the project repository.
Emergency Diagnostics: Reduces friction and prevents path resolution mistakes during incident triage and rapid troubleshooting.
System Management Parity: Aligns hikctl with standard production server utilities, allowing monitoring agents, scheduled tasks, and third-party orchestration tools to invoke the management tool uniformly without hardcoding filesystem paths.
Reduced User Error: Eliminates common user confusion around missing executables or running commands from unexpected working directories.

Scope & Acceptance Criteria

The registration must be handled seamlessly during the setup phase.
It must comprehensively cover all operating systems supported by the gateway (Windows Server/Desktop and Linux distributions).
It must support global availability so administrative shells and background orchestration have access.

## Need Statement Currently, executing `hikctl` requires operators to navigate directly into the installation directory and reference the script relatively (e.g., `.\hikctl.cmd` or `./hikctl`) or supply full absolute paths. Running `hikctl setup` should automatically register `hikctl` onto the system `PATH` so it is globally invocable from any shell or directory. ## Rationale & Benefits - **Operator Ergonomics & Speed**: System administrators can run operational commands (`hikctl status`, `hikctl doctor`, `hikctl logs`, `hikctl service restart`) from anywhere without having to locate or `cd` into the project repository. - **Emergency Diagnostics**: Reduces friction and prevents path resolution mistakes during incident triage and rapid troubleshooting. - **System Management Parity**: Aligns `hikctl` with standard production server utilities, allowing monitoring agents, scheduled tasks, and third-party orchestration tools to invoke the management tool uniformly without hardcoding filesystem paths. - **Reduced User Error**: Eliminates common user confusion around missing executables or running commands from unexpected working directories. ## Scope & Acceptance Criteria - The registration must be handled seamlessly during the `setup` phase. - It must comprehensively cover all operating systems supported by the gateway (Windows Server/Desktop and Linux distributions). - It must support global availability so administrative shells and background orchestration have access.

gabogg added the

needs-triage

label

2026-09-18 17:32:14 +00:00

gabogg referenced this issue

2026-09-21 18:35:05 +00:00

feat(cli): lightweight db init, credential hygiene, and persistent door exclusions (#41, #43, #48) #45

gabogg referenced this issue

2026-09-21 18:54:41 +00:00

feat(cli): lightweight db init, credential hygiene, and persistent door exclusions (#41, #43, #48) #45

gabogg referenced this issue

2026-09-21 19:41:30 +00:00