docs(cli): document the `harper deploy` command by Ethan-Arrowood · Pull Request #624 · HarperFast/documentation

Ethan-Arrowood · 2026-08-12T14:54:51Z

Summary

Documents the harper deploy CLI command in the CLI reference. This command was undocumented on the commands page despite being available since v4.4.18 (with live streaming progress added in v5.1.0).

Sourced from the Harper core code (bin/cliOperations.ts, bin/help.ts, components/operations.js, components/operationsValidation.js).

Changes

reference/cli/commands.md — new ### harper deploy entry under Process Management, covering:
- Directory deploy (packages the current working directory) vs. package-reference deploy (package=<ref>)
- Local vs. remote (target=<url>) deploys and how remote auth is resolved
- Live SSE progress (upload bar + streamed install output; prepare → load → replicate → restart) added in v5.1.0, with the automatic fallback for pre-5.1 servers
- The deployment_id / system.hdb_deployment record
- Every supported parameter: project, package, target, restart (true/rolling), replicated, install_command, install_timeout, install_allow_scripts, deployment_timeout, ignore_replication_errors, force, urlPath, host, credentials, json, plus the directory-packaging options skip_node_modules and skip_symlinks
- Cross-links to the deploy_component operation for full server-side behavior
reference/cli/overview.md — added harper deploy to the command table (Prettier realigned the table, hence the extra line churn)

Verification

npm run format:check — clean
npm run build — succeeds; the two broken-anchor warnings are pre-existing (on backups/overview and release-notes/5.1) and unrelated to this change

_{sent with Claude Opus 4.8}

Add a full reference entry for `harper deploy` on the CLI commands page, covering both directory (current-working-directory) and package-reference deploys, local vs. remote (`target=`) usage, live SSE progress introduced in v5.1.0, and every supported parameter (restart/replicated, install options, deployment/replication controls, urlPath/host, credentials, and the directory-packaging options skip_node_modules/skip_symlinks). Cross-link the `deploy_component` operation for full server-side behavior. Also add `harper deploy` to the command table in the CLI overview. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

github-actions · 2026-08-12T14:57:31Z

🚀 Preview Deployment

Your preview deployment is ready!

🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-624

This preview will update automatically when you push new commits.

gemini-code-assist

Code Review

This pull request documents the 'harper deploy' CLI command. It adds a detailed section to 'reference/cli/commands.md' explaining how to package and deploy Harper components, along with parameters and packaging options. It also updates the command table in 'reference/cli/overview.md' to include 'harper deploy'. There are no review comments, so I have no feedback to provide.

kriszyp

Looks good, but some timeline cleanup to address.
_{🤖 Reviewed with Codex}

…rams - Date the `deploy` command to v4.3.0 (matching the CLI operations inventory) and note package-reference support arrived in v4.4.18, instead of badging the whole command v4.4.18. - Annotate the v5.2.0 parameters inline: `host`, `deployment_timeout`, and `ignore_replication_errors`. - Add `deployment_timeout` and `ignore_replication_errors` to the canonical `deploy_component` operation reference (both v5.2.0) so the CLI page cross-reference resolves to a documented contract. - Rework the `credentials` bullet: it is an array of objects, which the CLI's key=value args cannot represent, so direct private-source deploys to the HTTP Operations API instead of advertising credentials=<json>. - Mention the legacy `username`/`password` auth params alongside `auth_username`/`auth_password`. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

github-actions · 2026-08-13T13:13:39Z

🚀 Preview Deployment

Your preview deployment is ready!

🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-624

This preview will update automatically when you push new commits.

…ence - Fix `deployment_timeout` and `ignore_replication_errors` version to v5.1.4 (not v5.2.0) on both the CLI commands page and the canonical deploy_component operation reference. Both landed in #1338/#1334 and first shipped in v5.1.4; a human reviewer confirmed the version. - Document deploy-by-reference (v5.2.3): the `by_ref`, `ref`, `credential`, and `setup` args, with a "Deploy by reference" section. - Rework private-source deploy guidance: private git repositories use `harper deploy setup=true` to seal a durable credential, then `by_ref=true credential=true`; private npm registries still go through the HTTP Operations API (the CLI cannot express the nested credentials array). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

github-actions · 2026-08-21T21:27:13Z

🚀 Preview Deployment

Your preview deployment is ready!

🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-624

This preview will update automatically when you push new commits.

The prior text claimed the CLI cannot express array-of-object params and routed private npm registry auth to the HTTP Operations API. That is false: `buildRequest()` JSON-parses every arg value except `ref`, so `credentials='[...]'` works, and `harper deploy setup=true` supports both git and npm providers, printing exactly that line to use. - Rework "Private deploy sources" around `harper deploy setup=true` for both private git and private npm registries, sealing the token client-side rather than passing a raw token on the command line. - Show the CLI-native private npm deploy (shell-quoted `credentials` JSON array) instead of steering to HTTP. - Add `credentials='<json>'` (v5.2.0) back to the parameter list. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

github-actions · 2026-08-26T22:08:39Z

🚀 Preview Deployment

Your preview deployment is ready!

🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-624

This preview will update automatically when you push new commits.

github-actions · 2026-08-28T17:57:45Z

🧹 Preview Cleanup

The preview deployment for this PR has been removed.

Ethan-Arrowood requested a review from a team as a code owner August 12, 2026 14:54

github-actions Bot temporarily deployed to pr-624 August 12, 2026 14:57 Inactive

gemini-code-assist Bot reviewed Aug 12, 2026

View reviewed changes

cb1kenobi reviewed Aug 12, 2026

View reviewed changes

Comment thread reference/cli/commands.md Outdated

Comment thread reference/cli/commands.md Outdated

Comment thread reference/cli/commands.md Outdated

kriszyp reviewed Aug 12, 2026

View reviewed changes

Comment thread reference/cli/commands.md Outdated

Comment thread reference/cli/commands.md Outdated

Comment thread reference/cli/commands.md Outdated

Comment thread reference/cli/commands.md Outdated

github-actions Bot temporarily deployed to pr-624 August 13, 2026 13:13 Inactive

kriszyp approved these changes Aug 14, 2026

View reviewed changes

cb1kenobi reviewed Aug 15, 2026

View reviewed changes

Comment thread reference/cli/commands.md Outdated

Comment thread reference/operations-api/operations.md Outdated

Comment thread reference/cli/commands.md Outdated

cb1kenobi requested changes Aug 19, 2026

View reviewed changes

Comment thread reference/operations-api/operations.md Outdated

Comment thread reference/cli/commands.md Outdated

github-actions Bot temporarily deployed to pr-624 August 21, 2026 21:27 Inactive

dawsontoth reviewed Aug 21, 2026

View reviewed changes

Comment thread reference/cli/commands.md

cb1kenobi reviewed Aug 24, 2026

View reviewed changes

Comment thread reference/cli/commands.md Outdated

Ethan-Arrowood mentioned this pull request Aug 26, 2026

CLI docs claim array-of-object parameters are unsupported, but they work #639

Closed

github-actions Bot temporarily deployed to pr-624 August 26, 2026 22:08 Inactive

Ethan-Arrowood requested a review from cb1kenobi August 26, 2026 22:20

This was referenced Aug 27, 2026

docs(cli): object and array-of-object params do work via CLI #646

Merged

docs: fix broken anchors and stale HarperDB org URLs #649

Merged

cb1kenobi approved these changes Aug 28, 2026

View reviewed changes

dawsontoth approved these changes Aug 28, 2026

View reviewed changes

Ethan-Arrowood merged commit 0841ba6 into main Aug 28, 2026
8 checks passed

Ethan-Arrowood deleted the docs/cli-deploy-command branch August 28, 2026 17:57

Uh oh!

Conversation

Ethan-Arrowood commented Aug 12, 2026

Summary

Changes

Verification

Uh oh!

github-actions Bot commented Aug 12, 2026

🚀 Preview Deployment

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kriszyp left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Aug 13, 2026

🚀 Preview Deployment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Aug 21, 2026

🚀 Preview Deployment

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Aug 26, 2026

🚀 Preview Deployment

Uh oh!

Uh oh!

github-actions Bot commented Aug 28, 2026

🧹 Preview Cleanup

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants