Skip to content

Add the get.flox.dev install script to the install options - #57

Open
djsauble wants to merge 4 commits into
mainfrom
daniel/install-script-get-flox-dev
Open

Add the get.flox.dev install script to the install options#57
djsauble wants to merge 4 commits into
mainfrom
daniel/install-script-get-flox-dev

Conversation

@djsauble

@djsauble djsauble commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

What

Adds the web-hosted install script (curl -fsSL https://get.flox.dev | sh) to the documented install options.

Draft — do not merge yet. This PR previews the user-facing experience for the install-script spec review (DEV-146). It should land only once get.flox.dev is live and serving the script.

Stacked on #61 (Nix/MacOS tab consolidation, split out per spec review). This PR's base is daniel/consolidate-install-tabs so the preview shows the consolidated tabs and the #nix anchor the script links to; GitHub retargets it to main automatically once #61 merges.

Changes

  • install-flox/install.mdx — new Install Script tab: the one-line command, how the script chooses an install method, a verified sample transcript (Ubuntu), the existing-Nix behavior (per spec review the script never installs through Nix — it stops and links to the Nix tab, and flox-installers#499 was updated to match), the sudo-preview behavior, refused systems, and FLOX_CHANNEL / FLOX_VERSION pinning.
  • install-flox/uninstall.mdx and the mirrored uninstaller block in install-flox/troubleshooting.mdx — matching Install Script tab that routes to the package-manager tabs.
  • install-flox/troubleshooting.mdx — "Reporting issues" now lists the install script as an install method.
  • index.mdx — the Get Started card leads with the one-line install.
  • tutorials/installing-from-repo.mdx — intro note mentions the script as an automation alternative.

The sample transcripts were derived line-by-line from the shipped install.sh (flox-installers repo, feature/flox-install-sh), and every embedded version string uses a form the daily update-flox-version.yml sed rewrite matches, so the transcripts won't go stale.

Spec review follow-ups (2026-08-05)

Open questions for spec review

  1. Tab placement/name — this draft makes "Install Script" the first (default) tab, on the theory that the one-liner is the headline convenience method (mise/uv-style). Happy to move it after RPM if we'd rather not change the default.
  2. Checksums note — the page-top checksums <Note> doesn't apply cleanly to the script flow (the script verifies nothing itself on the deb path beyond apt; rpm imports the signing key). Left unchanged here; worth a follow-up.
  3. imageless-kubernetes/install/self-managed.mdx mentions only rpm/deb availability; optionally reword once the script is live.

🤖 Generated with Claude Code

@mintlify

mintlify Bot commented Aug 3, 2026

Copy link
Copy Markdown

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

Project Status Preview Updated (UTC)
flox 🟢 Ready View Preview Aug 3, 2026, 4:51 PM

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

@djsauble
djsauble marked this pull request as ready for review August 3, 2026 18:05
@djsauble

djsauble commented Aug 5, 2026

Copy link
Copy Markdown
Contributor Author

Some feedback from spec review today:

  1. All of the Nix install tabs (generic, NixOS, determinate) should be consolidated into one (unrelated to this PR so it could be a separate PR). This will help keep the tabs from scrolling horizontally. I think the two macOS tabs (Pkg, Homebrew) could be consolidated in the same way, again it's unrelated to this install.sh PR, so I'd add these changes as a separate commit to the Nix tabs consolidation PR).

  2. The install.sh script should not attempt to install Flox with Nix. Let's cut that from the script itself (https://github.com/flox/flox-installers/pull/499) and also close the other PR that attempts to handle Determinate Nix gracefully (https://github.com/flox/flox-installers/pull/505). The script should just detect if Nix is already installed, and if so, provide a link to the (soon-to-be-consolidated) Nix tab on the Install Flox page (https://flox-daniel-install-script-get-flox-dev.mintlify.site/install-flox/install#nix).

  3. Open a new Linear triage issue in the CLI team to add analytics to the install.sh script (so that we can see what the script attempted to do, and if it failed to install Flox, why that was).

@djsauble
djsauble force-pushed the daniel/install-script-get-flox-dev branch from a58ed47 to cf1b98e Compare August 5, 2026 16:20
@djsauble
djsauble changed the base branch from main to daniel/consolidate-install-tabs August 5, 2026 16:20
@djsauble
djsauble force-pushed the daniel/consolidate-install-tabs branch from 51c87a6 to 7d553ce Compare August 5, 2026 17:30
Base automatically changed from daniel/consolidate-install-tabs to main August 5, 2026 17:32
djsauble and others added 2 commits August 5, 2026 10:52
Documents the curl|sh installer as a new "Install Script" tab on the
install page, with verified sample transcripts, the existing-Nix
behavior (nix profile install + Flox cache in nix.conf), sudo command
preview, refused systems, and FLOX_CHANNEL/FLOX_VERSION pinning.
Adds matching uninstall/troubleshooting tabs and mentions on the
index and repo-install tutorial.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Per spec review, the install script now stops when it detects an
existing Nix and links to the consolidated Nix tab instead of running
nix profile install. Drop the nix-path accordion and the nix profile
remove instructions from the install/uninstall/troubleshooting tabs,
and point remaining links at the consolidated #nix anchor.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
djsauble and others added 2 commits August 5, 2026 11:45
Promote the tab's bold pseudo-headings to ## headings so Mintlify's
tab-aware "On this page" rail navigates the tab, matching the MacOS
and Nix tabs.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…adings

Convert the bold pseudo-headings in the Debian, RPM, Container, and
WSL 2 tabs to ## headings so every tab on the page gets Mintlify's
tab-aware "On this page" navigation, completing the pattern started
for the MacOS and Nix tabs. Bold titles inside accordions are left
as-is (headings there don't reach the ToC).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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