Skip to content

docs(cli): document --use-device-auth flag for up and login#883

Open
andreasgerner wants to merge 1 commit into
netbirdio:mainfrom
andreasgerner:docs/use-device-auth-flag
Open

docs(cli): document --use-device-auth flag for up and login#883
andreasgerner wants to merge 1 commit into
netbirdio:mainfrom
andreasgerner:docs/use-device-auth-flag

Conversation

@andreasgerner

@andreasgerner andreasgerner commented Jul 24, 2026

Copy link
Copy Markdown

Documents the new CLI command flag to force device code flow


View with [code]smith Autofix with [code]smith
Need help on this PR? Tag @codesmith-bot with what you need. Autofix is disabled.

Summary by CodeRabbit

  • Documentation
    • Added CLI reference documentation for the --use-device-auth flag in the netbird up and netbird login commands.

@vercel

vercel Bot commented Jul 24, 2026

Copy link
Copy Markdown

@andreasgerner is attempting to deploy a commit to the NetBird GmbH Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai

coderabbitai Bot commented Jul 24, 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: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: c44315a7-1ea0-4cc7-91c7-c48c9434173a

📥 Commits

Reviewing files that changed from the base of the PR and between f6ee418 and b53d634.

📒 Files selected for processing (1)
  • src/pages/get-started/cli.mdx

📝 Walkthrough

Walkthrough

The CLI reference now documents the --use-device-auth flag for both netbird up and netbird login.

Changes

CLI documentation

Layer / File(s) Summary
Document device authentication flags
src/pages/get-started/cli.mdx
Adds --use-device-auth to the netbird up and netbird login flag lists.

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

Suggested reviewers: techhuttv

Poem

A bunny reads the flags with care,
Device auth is now documented there.
up and login hop in line,
Clear CLI notes look mighty fine.
Nibble, review, and ship on time!

🚥 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 describes the documented --use-device-auth flag for the up and login commands.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

src/pages/get-started/cli.mdx

Oops! Something went wrong! :(

ESLint: 9.39.2

TypeError: Converting circular structure to JSON
--> starting at object with constructor 'Object'
| property 'configs' -> object with constructor 'Object'
| property 'flat' -> object with constructor 'Object'
| ...
| property 'plugins' -> object with constructor 'Object'
--- property 'react' closes the circle
Referenced from:
at JSON.stringify ()
at file:///node_modules/@eslint/eslintrc/lib/shared/config-validator.js:308:45
at Array.map ()
at ConfigValidator.formatErrors (file:///node_modules/@eslint/eslintrc/lib/shared/config-validator.js:299:23)
at ConfigValidator.validateConfigSchema (file:///node_modules/@eslint/eslintrc/lib/shared/config-validator.js:330:84)
at ConfigArrayFactory._normalizeConfigData (file:///node_modules/@eslint/eslintrc/lib/config-array-factory.js:676:19)
at ConfigArrayFactory._loadConfigData (file:///node_modules/@eslint/eslintrc/lib/config-array-factory.js:641:21)
at ConfigArrayFactory._loadExtendedShareableConfig (file:///node_modules/@eslint/eslintrc/lib/config-array-factory.js:946:21)
at ConfigArrayFactory._loadExtends (file:///node_modules/@eslint/eslintrc/lib/config-array-factory.js:814:25)
at ConfigArrayFactory._normalizeObjectConfigDataBody (file:///node_modules/@eslint/eslintrc/lib/config-array-factory.js:752:25)


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.

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