Skip to content

docs: document CLI version pinning#1311

Open
factory-davidgu wants to merge 1 commit into
mainfrom
david/docs-pin-cli-version
Open

docs: document CLI version pinning#1311
factory-davidgu wants to merge 1 commit into
mainfrom
david/docs-pin-cli-version

Conversation

@factory-davidgu

Copy link
Copy Markdown
Contributor

Description

Document how to pin the Droid CLI through npm, the built-in updater, or direct verified binary downloads. Clarify update command flags and how automatic updates interact with pinned standalone and npm installations.

How Has This Been Tested?

  • Ran git diff --check
  • Verified droid@0.174.0 exists on npm
  • Verified the Linux x64 binary and checksum endpoints for v0.174.0 return HTTP 200

Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com>
@factory-droid

factory-droid Bot commented Jul 18, 2026

Copy link
Copy Markdown
Contributor

Droid finished @factory-davidgu's task —— View job


Security Review

The documentation updates are clear and add useful guidance for pinning and installing specific CLI versions. The main remaining gaps are security and operational clarity around installation trust (especially curl | sh and same-host checksums) and a more explicit upgrade workflow when auto-updates are disabled.

@mintlify

mintlify Bot commented Jul 18, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
factory 🟢 Ready View Preview Jul 18, 2026, 12:24 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Comment thread docs/reference/cli-reference.mdx
Comment thread docs/reference/cli-reference.mdx
export FACTORY_DROID_AUTO_UPDATE_ENABLED=false
```

With this variable set, automatic updates are disabled and `droid update` does not install another

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[P1] Document how to intentionally upgrade when auto-updates are disabled

This section says that setting FACTORY_DROID_AUTO_UPDATE_ENABLED=false disables automatic updates and that droid update will not install another version, but it does not explain the intentional upgrade path for pinned standalone installs. Add a sentence telling readers to temporarily unset or flip the variable (or otherwise re-enable updates) when they want to run droid update --version <x>, then re-disable auto-updates to remain pinned.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant