docs: migrate CLI section to v4 consolidated reference#439
Open
Ethan-Arrowood wants to merge 1 commit intomajor-version-reorgfrom
Open
docs: migrate CLI section to v4 consolidated reference#439Ethan-Arrowood wants to merge 1 commit intomajor-version-reorgfrom
Ethan-Arrowood wants to merge 1 commit intomajor-version-reorgfrom
Conversation
87cfcd8 to
ebff698
Compare
kriszyp
reviewed
Feb 19, 2026
|
|
||
| - If Harper is not installed, it will guide you through the installation process | ||
| - Once installed, it runs Harper in the foreground as a standard process, compatible with systemd, Docker, and other process management tools | ||
| - Logs output directly to the console for easy monitoring |
Member
There was a problem hiding this comment.
This might take some clarification; logs doesn't necessary go to the console, the logger.stdStream config option controls whether logs go to stdout/stderr. And stdout/stderr goes to the console if the process is in the "foreground" (that's kind of part of the definition of a foreground process).
Member
Author
There was a problem hiding this comment.
I can work on clarifying this. Its important that we are technically accurate here to not cause any confusion
Migrated Harper CLI documentation from versioned_docs to new reference_versioned_docs/version-v4/cli/ structure following the v4 documentation consolidation plan. Files created: - reference_versioned_docs/version-v4/cli/overview.md - reference_versioned_docs/version-v4/cli/commands.md - reference_versioned_docs/version-v4/cli/operations-api-commands.md - reference_versioned_docs/version-v4/cli/authentication.md - migration-context/link-placeholders/cli-link-placeholders.md Key Features: Version Annotations - All 72 CLI operations now include "Available Since" information with complete version coverage: - 51 operations from v4.3.0 - 11 operations from v4.4.0 (SSH and certificate operations) - 3 data operations from v4.4.9 (insert, update, upsert) - 3 status operations from v4.6.0 - Individual operations from v4.7.2 and v4.7.3 Authentication Documentation - Corrected to explain Unix domain socket authentication for local operations (automatically authenticated as superuser). Detailed environment variable and command parameter methods for remote operations with security best practices. Operations API Commands - Complete operations table with all 72 operations categorized by function, command aliases, parameter formatting guidelines, and cross-references to related sections via tip callouts. Process Management - Documented PID file location at <ROOTPATH>/hdb.pid, clarified foreground/background behavior for commands, and updated dev mode features. Link Management - 12 internal CLI section links resolved using relative paths. ~96 cross-section TODO links documented for future resolution in cli-link-placeholders.md. Content Consolidation - Merged content from v4.1 through v4.7 with inline version annotations following Node.js documentation patterns. Migration approach: - Single consolidated v4 reference (no separate v4.1-v4.7 versions) - Inline version annotations for feature availability - TODO: prefix for cross-section links pending future migrations - Comprehensive source attribution in HTML comments - Learn guide links use /learn paths - Consistent use of 'harper' command throughout 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
a3e3b4c to
4c90529
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
CLI Section Migration
Summary
Migration of CLI documentation from versioned_docs into new consolidated reference structure at
reference_versioned_docs/version-v4/cli/.Files Created
reference_versioned_docs/version-v4/cli/overview.md- General CLI overview with installation path, ROOTPATH configuration, process ID file location, system management commands, remote operations, and development modereference_versioned_docs/version-v4/cli/commands.md- Detailed reference for core CLI commands (start, run, dev, restart, stop, status, compact)reference_versioned_docs/version-v4/cli/operations-api-commands.md- Complete operations available through CLI with version information for all 72 operationsreference_versioned_docs/version-v4/cli/authentication.md- Authentication mechanisms for local (Unix domain sockets) and remote operationsmigration-context/link-placeholders/cli-link-placeholders.md- Comprehensive tracking of all TODO links for future cross-section resolutionKey Features
Version Annotations
All CLI operations now include "Available Since" information:
add_ssh_key,update_ssh_key,delete_ssh_key,list_ssh_keys,set_ssh_known_hosts,get_ssh_known_hosts+ 5 certificate operations:create_csr,sign_certificate,list_certificates,add_certificate,remove_certificate)insert,update,upsert)get_status,set_status,clear_status)get_ssh_keyfrom v4.7.2get_usage_licensesfrom v4.7.3Content Consolidation
Merged content from v4.1 through v4.7 with inline version annotations following Node.js documentation patterns (e.g., "Available since: v4.3.0; expanded in: v4.7.0").
Authentication Documentation
CLI_TARGET_USERNAME,CLI_TARGET_PASSWORD) and command parameter methods for remote operationsOperations API Commands
deploy→deploy_component,package→package_componentProcess Management
<ROOTPATH>/hdb.pidfor external process management toolsharper runruns in foreground mode (not background)harper devfeatures: logs to standard streams, single-threaded executionharper restartworks with both foreground and background processesLink Management
./overview.md,./commands.md, etc.)cli-link-placeholders.mdwith line numbers, context, target, and statusSource Files Used
reference_versioned_docs/version-v4/cli/overview.md
versioned_docs/version-4.7/deployments/harper-cli.md(primary source)versioned_docs/version-4.4/deployments/harper-cli.md(for baseline features)release-notes/v4-tucker/4.3.0.md(confirmed CLI expansion in v4.3.0)release-notes/v4-tucker/4.2.0.md(confirmed dev mode in v4.2.0)release-notes/v4-tucker/4.1.0.md(confirmed foreground mode changes in v4.1.0)reference_versioned_docs/version-v4/cli/commands.md
versioned_docs/version-4.7/deployments/harper-cli.md(primary)release-notes/v4-tucker/4.2.0.md(dev mode commands)release-notes/v4-tucker/4.1.0.md(foreground mode changes)reference_versioned_docs/version-v4/cli/operations-api-commands.md
versioned_docs/version-4.7/deployments/harper-cli.md(primary)release-notes/v4-tucker/4.3.0.md(confirmed CLI expansion with operations API commands in v4.3.0)reference_versioned_docs/version-v4/cli/authentication.md
versioned_docs/version-4.7/deployments/harper-cli.md(primary)versioned_docs/version-4.4/deployments/harper-cli.md(baseline features)Migration Approach
This migration follows the established patterns:
TODO:prefix for cross-section links pending future migrations/learnpathsharpercommand (notharperdb) throughoutNext Steps
Pending link resolutions will be addressed in future section migrations:
Total Pending Links: ~96
Notes
This is Pilot Section 1 of the v4 documentation migration, chosen for:
The migration successfully:
harperdbcommand references (replaced withharper)