Repository navigation
docs: reorganize navigation and integration guidance #118
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
willkill07
merged 9 commits into
NVIDIA:release/0.2
from
willkill07:wkk_docs/nemo-flow-cli-docs
May 15, 2026
Merged
Changes from 1 commit
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
b4ae389
docs: reorganize CLI and README guidance
willkill07 29a4874
docs: refresh package README guidance
willkill07 818b5f1
docs: consolidate plugin documentation
willkill07 fafdcd4
docs: refine navigation and terminology
willkill07 3301f59
chore: update documentation to include lang versioning
willkill07 567429f
docs: fix duplicate FAQ subscriber link
willkill07 5d46331
Merge remote-tracking branch 'upstream/release/0.2' into wkk_docs/nem…
willkill07 b9995d5
Address reviewer feedback + release notes
willkill07 118f8b6
fix: add link to GitHub releases
willkill07 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| <!-- | ||
| SPDX-FileCopyrightText: Copyright (c) 2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved. | ||
| SPDX-License-Identifier: Apache-2.0 | ||
| --> | ||
|
|
||
| # About | ||
|
|
||
| Use this section when you want the `nemo-flow` binary to observe local coding | ||
| agent sessions through hooks, a passthrough LLM gateway, and NeMo Flow | ||
| observability exporters. | ||
|
|
||
| The NeMo Flow CLI is installed by the `nemo-flow-cli` Cargo package. It can run | ||
| supported coding agents through a managed local gateway, forward agent hook | ||
| payloads into NeMo Flow lifecycle events, route OpenAI-compatible or | ||
| Anthropic-compatible model traffic through the gateway, and diagnose local | ||
| configuration. | ||
|
|
||
| ## Start Here When | ||
|
|
||
| Use these guides when you need to: | ||
|
|
||
| - Observe Claude Code, Codex, Cursor, or Hermes Agent sessions locally. | ||
| - Configure coding-agent hooks for NeMo Flow lifecycle events. | ||
| - Route model-provider traffic through the local NeMo Flow gateway. | ||
| - Export local sessions to ATIF, ATOF JSONL, OpenTelemetry, or OpenInference. | ||
| - Diagnose hook loading, gateway routing, and exporter output. | ||
|
|
||
| If you are instrumenting an application or framework directly, use | ||
| [Instrument Applications](../instrument-applications/about.md) or | ||
| [Integrate into Frameworks](../integrate-frameworks/about.md) instead. | ||
|
|
||
| ## Agent Harness Support | ||
|
|
||
| NeMo Flow CLI support is experimental and observability-focused. | ||
|
|
||
| | Agent | Observability | Security | Optimization | Notes | | ||
| | --- | --- | --- | --- | --- | | ||
| | Claude Code | ✅ Yes | ❌ No | ❌ No | Observability only; no known issues. | | ||
| | Codex | ✅ Yes | ❌ No | ❌ No | Observability only; some hooks needed for full feature coverage are missing. | | ||
| | Hermes Agent | ✅ Yes | ❌ No | ❌ No | Observability only; no known issues. | | ||
| | Cursor | ✅ Yes | ❌ No | ❌ No | Observability only; missing hooks under `cursor-agent` limit feature coverage. | | ||
|
|
||
| ## Guides | ||
|
|
||
| Use these guide links to move from CLI setup into agent-specific instructions. | ||
|
|
||
| - [Basic Usage](basic-usage.md) explains gateway routes, transparent runs, | ||
| shared configuration, hook forwarding, and runtime mapping. | ||
| - [Claude Code](claude-code.md) covers transparent Claude Code | ||
| runs, Anthropic gateway routing, ATIF verification, and unsupported Claude | ||
| application modes. | ||
| - [Codex](codex.md) covers transparent Codex CLI runs, local | ||
| GUI/app caveats, model provider routing, and remote-task limits. | ||
| - [Cursor](cursor.md) covers transparent Cursor runs, temporary | ||
| hook patching, GUI and CLI smoke tests, and gateway routing limits. | ||
| - [Hermes Agent](hermes.md) covers Hermes shell hook installation, | ||
| dynamic gateway URL handling, session-finalize behavior, and hook consent | ||
| caveats. | ||
|
|
||
| Start with [Basic Usage](basic-usage.md), then use the guide for the coding | ||
| agent that you want to observe. |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.