Skip to content

docs: surface standalone installer in README and INSTALL.md#104

Merged
saadqbal merged 3 commits intomainfrom
docs/standalone-installer-103
May 6, 2026
Merged

docs: surface standalone installer in README and INSTALL.md#104
saadqbal merged 3 commits intomainfrom
docs/standalone-installer-103

Conversation

@saadqbal
Copy link
Copy Markdown
Contributor

@saadqbal saadqbal commented May 6, 2026

Summary

The standalone installer (bash <(curl -fsSL tracebloc.io/i.sh) / irm tracebloc.io/i.ps1 | iex) is the one-command path for evaluation, local dev, and first-time installs — it provisions a cluster, auto-detects GPU drivers (NVIDIA / AMD), and deploys the client. Today it isn't documented anywhere reachable from this repo, so readers only see the multi-step helm install flow.

README — adds a Quick install subsection at the top of the Deploy section with macOS/Linux and Windows one-liners, plus a pointer to the local scripts/install-k8s.sh / scripts/install-k8s.ps1 helpers. The existing helm flow is relabeled Helm install (production) and reframed as the option for existing production clusters.

docs/INSTALL.md — top-of-doc callout pointing non-production readers at the standalone installer. The rest of the production-focused content is untouched.

Closes #103

Test plan

  • Skim rendered README and INSTALL.md on the PR diff
  • Click scripts/install-k8s.sh and scripts/install-k8s.ps1 links — confirm they resolve
  • Verify tracebloc.io/i.sh and tracebloc.io/i.ps1 still resolve (currently both serve the bootstrap script)
  • Run bash <(curl -fsSL tracebloc.io/i.sh) end-to-end on a fresh macOS or Linux machine — confirm it lands a healthy client install

🤖 Generated with Claude Code


Note

Low Risk
Low risk documentation-only change that adds install guidance and links; no code or configuration behavior is modified.

Overview
Adds a Quick install path to the README, documenting one-command macOS/Linux and Windows bootstrap installers and linking to the repo’s helper scripts (scripts/install-k8s.sh/scripts/install-k8s.ps1).

Updates docs/INSTALL.md with an upfront callout pointing users without an existing cluster to the standalone installer, while keeping the rest of the Helm-based production install instructions unchanged.

Reviewed by Cursor Bugbot for commit 9f10e8d. Bugbot is set up for automated code reviews on this repo. Configure here.

The standalone installer (bash <(curl -fsSL tracebloc.io/i.sh) /
irm tracebloc.io/i.ps1 | iex) is the one-command path for evaluation,
local dev, and first-time installs — it provisions a cluster, detects
GPU drivers, and deploys the client. Today it isn't documented anywhere
reachable from this repo, so readers see the multi-step helm install
flow as the only option.

README:
- New "Quick install" subsection at the top of Deploy with macOS/Linux
  and Windows commands, brief description of what it does, and a
  pointer to the local helper scripts under scripts/
- Existing helm flow relabeled as "Helm install (production)" — now
  positioned as the option for existing production clusters

docs/INSTALL.md:
- Top-of-doc callout pointing at the standalone installer for
  non-production users
- Production-focused content untouched

Closes #103

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Copy link
Copy Markdown

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

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

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit 885ae18. Configure here.

Comment thread README.md Outdated
saadqbal added 2 commits May 6, 2026 16:27
Previous wording ("Best for evaluation, local dev, and first-time
installs" / "Just trying it out? For local dev or a quick evaluation")
implied the standalone installer produces a lesser/demo client. It
doesn't — it produces the same full client, just on a cluster the
script provisions for you.

Reframes the differentiator around cluster ownership instead of install
quality:
- README: "Use this when you don't already have a cluster — the result
  is a full client install, not a demo." Helm subsection retitled
  from "Helm install (production)" to just "Helm install" with
  "For existing Kubernetes clusters".
- INSTALL.md: callout opens with "Don't have a Kubernetes cluster
  yet?" and emphasizes "a full tracebloc client".

Refs #103
curl and PowerShell's irm both default to HTTP when no scheme is
specified, so `curl -fsSL tracebloc.io/i.sh` and `irm tracebloc.io/i.ps1`
issue plaintext requests. The downloaded body is piped straight into
bash / iex, so a network-level attacker between the user and tracebloc.io
could MITM the response and inject arbitrary code.

Add explicit `https://` to every installer URL in README.md and
docs/INSTALL.md so the request is encrypted from the first byte.

Refs #103
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.

docs: add standalone installer (i.sh / i.ps1) to README and INSTALL.md

3 participants