Skip to content

docs: Document installing runpodctl with Nix - #910

Merged
lavanya-gunreddi merged 3 commits into
mainfrom
promptless/runpodctl-nix-install
Oct 16, 2026
Merged

lavanya-gunreddi merged 3 commits into
mainfrom
promptless/runpodctl-nix-install

Conversation

@promptless

@promptless promptless Bot commented Oct 16, 2026 •

Copy link
Copy Markdown
Contributor

Open in Promptless

runpod/runpodctl#373 added a Nix flake, so Nix users can now install or run runpodctl straight from GitHub. This PR adds a Nix tab to the installation methods on the Runpod CLI overview page. The tab covers nix profile install github:runpod/runpodctl, one-off use with nix run, the supported platforms (Linux x86_64/aarch64 and macOS arm64), and a note that runpodctl update doesn't work on Nix installs, so users should upgrade with nix profile upgrade instead.

The Nix tab follows the same structure as the other install tabs: a one-sentence intro with supported platforms, then bold labels above each command.

The rest of the flake (dev shell, checks, static analysis, and OCI images) is contributor tooling, so it isn't documented here.

Review feedback applied (@lavanya-gunreddi):

  • Removed the comma before "because" in the Note, using the reviewer's suggested wording verbatim.
  • Replaced the "Install runpodctl onto your PATH:" and "Or run a single command without installing it:" lead-ins with bold labels (Install: and Run without installing:), matching the conda / mamba / pixi tab.
  • Rewrote the intro in active voice and second person ("Install runpodctl from its Nix flake... You need Nix with flakes enabled."), and listed platforms in the same format as the conda tab. The tab uses sentence case and contains no em dashes.

Verification: the commands, supported platforms, and the update caveat come from flake.nix and nix/README.md in runpodctl.

Trigger Events


Tip: Tag @Promptless in GitHub PR comments to guide documentation changes during code review 🐙

Comment thread runpodctl/overview.mdx Outdated
Comment thread runpodctl/overview.mdx
Comment thread runpodctl/overview.mdx Outdated
@mintlify

mintlify Bot commented Oct 16, 2026 •

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated
runpod-docs 🟢 Ready View Preview Oct 16, 2026, 6:14 PM

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

@lavanya-gunreddi

Copy link
Copy Markdown
Contributor

@Promptless Doc style: sentence case, active voice, second person, no em dashes
The Note has an unnecessary comma before “because” it should read: runpodctl update doesn't work on a Nix install because it replaces its own binary and the Nix store is read-only.
Whether “Install runpodctl onto your PATH:” is the right lead-in or if it can be simplified
Consistency with how the other install tabs are structured

@promptless

promptless Bot commented Oct 16, 2026

Copy link
Copy Markdown
Contributor Author

In reply to this discussion

Thanks, I'll fix the comma in the Note, simplify the lead-in, and align this tab with the other install tabs, following sentence case, active voice, second person, and no em dashes. I'll reply here when the changes are on this branch.

@promptless

promptless Bot commented Oct 16, 2026

Copy link
Copy Markdown
Contributor Author

In reply to this discussion

All four points are addressed in commit 892a7055 on this branch.

  1. Doc style: The intro now uses active voice and second person: "Install runpodctl from its Nix flake on Linux (x86_64, aarch64) or macOS (arm64). You need Nix with flakes enabled." The labels use sentence case, and the Nix tab has no em dashes.
  2. Comma in the Note: The Note now uses your wording exactly: "runpodctl update doesn't work on a Nix install because it replaces its own binary and the Nix store is read-only."
  3. Lead-in: "Install runpodctl onto your PATH:" is now the bold label Install:, and "Or run a single command without installing it:" is now Run without installing:.
  4. Consistency: The Nix tab now matches the conda / mamba / pixi tab. It has a one-sentence intro that names the platforms in the same format, and a bold label above each code block.

One em dash remains on the page, outside the Nix tab, in the shell completion section ("The command is idempotent—running it again…"). It was there before this PR, so I left it unchanged.

PR: #910

@lavanya-gunreddi
lavanya-gunreddi merged commit 520a176 into main Oct 16, 2026
2 checks passed
@lavanya-gunreddi
lavanya-gunreddi deleted the promptless/runpodctl-nix-install branch October 16, 2026 19:39

This branch was successfully deployed

1 active deployment
staging — 62a1ac01 Deployed Oct 16, 2026 by mintlify[bot]
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