Skip to content

Overhault Nitro CLI docs#9643

Merged
tobias-tengler merged 5 commits intomainfrom
tte/nitro-cli-docs
May 6, 2026
Merged

Overhault Nitro CLI docs#9643
tobias-tengler merged 5 commits intomainfrom
tte/nitro-cli-docs

Conversation

@tobias-tengler
Copy link
Copy Markdown
Member

No description provided.

@github-actions github-actions Bot added 📚 documentation This issue is about working on our documentation. 🌶️ website labels May 4, 2026
@tobias-tengler tobias-tengler marked this pull request as ready for review May 6, 2026 14:06
Copilot AI review requested due to automatic review settings May 6, 2026 14:06
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR restructures and expands the Nitro CLI documentation by replacing the older cli-commands/* docs set with a new cli/* command reference set, updating the docs navigation accordingly, and making a small CLI/runtime change to nitro launch so it opens the correct Nitro UI URL for self-hosted/dedicated sessions (with accompanying tests).

Changes:

  • Added new Nitro CLI command documentation pages under website/src/docs/nitro/cli/* (api, schema, client, fusion, openapi, etc.) and removed the legacy website/src/docs/nitro/cli-commands/* pages.
  • Updated website/src/docs/docs.json to reflect the new CLI documentation structure.
  • Updated nitro launch to resolve the target URL from the active session and introduced an IBrowserLauncher abstraction with tests.

Reviewed changes

Copilot reviewed 41 out of 41 changed files in this pull request and generated 8 comments.

Show a summary per file
File Description
website/src/docs/nitro/cli/workspace.md New workspace command documentation page.
website/src/docs/nitro/cli/stage.md New stage command documentation page.
website/src/docs/nitro/cli/session.md New session/auth-related command documentation page.
website/src/docs/nitro/cli/schema.md New schema command documentation page.
website/src/docs/nitro/cli/pat.md New personal access token command documentation page.
website/src/docs/nitro/cli/openapi.md New OpenAPI collection command documentation page.
website/src/docs/nitro/cli/mcp.md New MCP feature collection command documentation page.
website/src/docs/nitro/cli/installation.md New installation documentation page (dotnet tool/npm/brew/binaries).
website/src/docs/nitro/cli/index.md Removes the old CLI intro page content (deleted).
website/src/docs/nitro/cli/global-options.md Rewrites/clarifies global options documentation (help/api-key/output/cloud-url).
website/src/docs/nitro/cli/fusion.md New Fusion CLI documentation page (includes publish multi-step flow).
website/src/docs/nitro/cli/environment.md New environment CLI documentation page.
website/src/docs/nitro/cli/client.md New client registry CLI documentation page.
website/src/docs/nitro/cli/api.md New API management CLI documentation page.
website/src/docs/nitro/cli/api-key.md New API key management CLI documentation page.
website/src/docs/nitro/cli/automation.md Removes legacy automation doc page (deleted).
website/src/docs/nitro/cli/authentication.md Removes legacy authentication doc page (deleted).
website/src/docs/nitro/cli-commands/workspace.md Removes legacy workspace command doc page (deleted).
website/src/docs/nitro/cli-commands/stage.md Removes legacy stage command doc page (deleted).
website/src/docs/nitro/cli-commands/schema.md Removes legacy schema command doc page (deleted).
website/src/docs/nitro/cli-commands/pat.md Removes legacy PAT command doc page (deleted).
website/src/docs/nitro/cli-commands/logout.md Removes legacy logout command doc page (deleted).
website/src/docs/nitro/cli-commands/login.md Removes legacy login command doc page (deleted).
website/src/docs/nitro/cli-commands/launch.md Removes legacy launch command doc page (deleted).
website/src/docs/nitro/cli-commands/fusion-configuration.md Removes legacy fusion-configuration command doc page (deleted).
website/src/docs/nitro/cli-commands/environment.md Removes legacy environment command doc page (deleted).
website/src/docs/nitro/cli-commands/client.md Removes legacy client command doc page (deleted).
website/src/docs/nitro/cli-commands/api.md Removes legacy api command doc page (deleted).
website/src/docs/nitro/cli-commands/api-key.md Removes legacy api-key command doc page (deleted).
website/src/docs/docs.json Updates docs navigation to point to new nitro/cli/* pages (but still references removed cli-commands and a missing mock page).
src/Nitro/CommandLine/test/CommandLine.Tests/Commands/Session/LaunchCommandTests.cs Adds coverage for nitro launch URL resolution behavior.
src/Nitro/CommandLine/test/CommandLine.Tests/Commands/CommandTestBase.cs Adds IBrowserLauncher mock registration to the test DI container.
src/Nitro/CommandLine/src/CommandLine/Options/SchemaFileOption.cs Switches schema file env var usage to shared constant.
src/Nitro/CommandLine/src/CommandLine/Options/ExtensionFileOption.cs Switches schema extension env var usage to shared constant.
src/Nitro/CommandLine/src/CommandLine/Options/EnvironmentVariables.cs Adds missing env var constants for schema file / schema extension file.
src/Nitro/CommandLine/src/CommandLine/Options/BaseSchemaFileOption.cs Switches base schema file env var usage to shared constant.
src/Nitro/CommandLine/src/CommandLine/Helpers/SystemBrowserLauncher.cs Adds system browser launcher implementation for DI.
src/Nitro/CommandLine/src/CommandLine/Helpers/IBrowserLauncher.cs Adds DI abstraction for opening URLs (testable browser launching).
src/Nitro/CommandLine/src/CommandLine/Helpers/Constants.cs Removes unused default timeout constant; keeps Nitro/API URLs.
src/Nitro/CommandLine/src/CommandLine/Extensions/ServiceCollectionExtensions.cs Registers IBrowserLauncher implementation in the CLI DI container.
src/Nitro/CommandLine/src/CommandLine/Commands/Launch/LaunchCommand.cs Updates nitro launch to open either the default Nitro web URL or <api-url>/ui based on the active session (now using IBrowserLauncher).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread src/Nitro/CommandLine/src/CommandLine/Commands/Launch/LaunchCommand.cs Outdated
Comment thread website/src/docs/docs.json Outdated
Comment thread website/src/docs/docs.json Outdated
Comment thread website/src/docs/nitro/cli/installation.md
Comment thread website/src/docs/nitro/cli/installation.md
Comment thread website/src/docs/nitro/cli/environment.md Outdated
Comment thread website/src/docs/nitro/cli/fusion.md Outdated
Comment thread website/src/docs/nitro/cli/openapi.md
@tobias-tengler tobias-tengler merged commit f9aa29d into main May 6, 2026
137 of 138 checks passed
@tobias-tengler tobias-tengler deleted the tte/nitro-cli-docs branch May 6, 2026 14:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

📚 documentation This issue is about working on our documentation. 🌶️ website

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants