Skip to content

docs: update tinybird CLI installation and auth steps#330

Open
devnucleus950 wants to merge 5 commits into
dubinc:mainfrom
devnucleus950:update-tinybird-docs
Open

docs: update tinybird CLI installation and auth steps#330
devnucleus950 wants to merge 5 commits into
dubinc:mainfrom
devnucleus950:update-tinybird-docs

Conversation

@devnucleus950

@devnucleus950 devnucleus950 commented Apr 14, 2026

Copy link
Copy Markdown

This PR updates the Tinybird CLI installation and authentication steps to use the modern flow, as the old interactive method via pip/pipx is deprecated.

Fixes dubinc/dub#3727

Summary by CodeRabbit

  • Documentation
    • Simplified CLI setup: installation now uses a single installer command for easier local setup.
    • Streamlined authentication: replaced the interactive token paste flow with a one-step login command to simplify sign-in.

@coderabbitai

coderabbitai Bot commented Apr 14, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: f322ebf5-b3dd-4ca2-9a77-b7b7098884a5

📥 Commits

Reviewing files that changed from the base of the PR and between bbc6b68 and 1e2a4f7.

📒 Files selected for processing (1)
  • docs/local-development.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/local-development.mdx

📝 Walkthrough

Walkthrough

Updates Tinybird CLI setup documentation to use the curl or PowerShell installer and changes authentication guidance from tb auth --interactive to tb login.

Changes

Tinybird CLI documentation

Layer / File(s) Summary
Update CLI installation and authentication
docs/local-development.mdx
Replaces conditional brew/pipx installation and interactive token authentication with the Tinybird installer and tb login.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related issues

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the main doc change: Tinybird CLI installation and authentication steps.
Linked Issues check ✅ Passed The docs now use the requested Tinybird install flow and tb login, matching issue #3727's core requirements.
Out of Scope Changes check ✅ Passed The changes stay focused on Tinybird CLI documentation and do not introduce unrelated scope.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

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.

Actionable comments posted: 1

🧹 Nitpick comments (1)
docs/local-development.mdx (1)

168-175: Align Tinybird setup wording across docs

This section now uses the new flow, but docs/self-hosting.mdx:103-117 still references a different installation path. Consider updating both docs to the same Tinybird setup flow to avoid conflicting instructions.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/local-development.mdx` around lines 168 - 175, The Tinybird install
instructions are inconsistent across docs: update the "Install the Tinybird CLI"
section (the paragraph that shows `curl https://tinybird.co | sh` and `tb
login`) to match the new flow used in local-development, and edit the older
self-hosting Tinybird section to use the identical wording and steps (same
install command, authentication via `tb login` and admin token) so both docs
present the same setup flow.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/local-development.mdx`:
- Around line 170-172: Update the code fence metadata for the command block that
currently uses "bash terminal" to match the repository's convention "bash
Terminal"; locate the triple-backtick fenced block containing the curl
https://tinybird.co | sh command and replace its opening fence metadata so it
reads "bash Terminal" (keep the command itself unchanged).

---

Nitpick comments:
In `@docs/local-development.mdx`:
- Around line 168-175: The Tinybird install instructions are inconsistent across
docs: update the "Install the Tinybird CLI" section (the paragraph that shows
`curl https://tinybird.co | sh` and `tb login`) to match the new flow used in
local-development, and edit the older self-hosting Tinybird section to use the
identical wording and steps (same install command, authentication via `tb login`
and admin token) so both docs present the same setup flow.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: ae1e8142-a026-4586-a283-61e279063a3f

📥 Commits

Reviewing files that changed from the base of the PR and between 2241f8b and d150364.

📒 Files selected for processing (1)
  • docs/local-development.mdx

Comment thread docs/local-development.mdx Outdated
@devkiran
devkiran requested a review from pepeladeira April 22, 2026 12:41

@pepeladeira pepeladeira left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

It wasn't necessary to paste a token. Just by running tb login, it was able to authenticate.

Comment thread docs/local-development.mdx Outdated
Co-authored-by: Pedro Ladeira <57876830+pepeladeira@users.noreply.github.com>
@devnucleus950

devnucleus950 commented Apr 23, 2026

Copy link
Copy Markdown
Author

Hey, @pepeladeira
Thanks for the feedback! I’ve applied the suggested change.

@pepeladeira

pepeladeira commented Apr 23, 2026

Copy link
Copy Markdown
Collaborator

@pepeladeira Thanks for the feedback! I’ve applied the suggested change.

@devnucleus950, also, I'm worried that the CLI command is only for MacOS and Linux. We should also mention the correct command for Windows users.

@devnucleus950

devnucleus950 commented Apr 23, 2026

Copy link
Copy Markdown
Author

I've added Windows-specific installation instructions as well.

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.

tb auth --interactive broken on legacy CLI; docs still reference outdated flow

2 participants