docs(nx-cloud): document --targets flag for start-agent#35554
Open
edbzn wants to merge 1 commit intonrwl:masterfrom
Open
docs(nx-cloud): document --targets flag for start-agent#35554edbzn wants to merge 1 commit intonrwl:masterfrom
edbzn wants to merge 1 commit intonrwl:masterfrom
Conversation
👷 Deploy request for nx-docs pending review.Visit the deploys page to approve it
|
👷 Deploy request for nx-dev pending review.Visit the deploys page to approve it
|
edbzn
force-pushed
the
docs/nx-cloud-start-agent-targets
branch
from
5261e4f to
55c7609
Compare
The bundled nx-cloud start-agent CLI advertises a --targets <csv> flag in its --help output, but it is not documented on nx.dev. Add it to the Cloud CLI reference and to the Manual DTE guide, with an example showing per-pool partitioning to isolate memory-heavy task families (e2e, builds, component-tests) on memory-constrained runners.
edbzn
force-pushed
the
docs/nx-cloud-start-agent-targets
branch
from
55c7609 to
8047b82
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Current Behavior
nx-cloud start-agentsupports a--targets <csv>flag (visible vianx-cloud start-agent --help) that pins an agent to a comma-separated subset of target names. The flag is not mentioned on https://nx.dev/docs/reference/nx-cloud-cli or in the Manual DTE guide, so users hitting OOM or contention on memory-constrained runners cannot discover it without reading the bundled CLI source.Expected Behavior
The flag is documented in:
nx-cloud start-agentOptions table on the Cloud CLI reference, with a short usage exampleRelated Issue(s)
N/A — documentation gap discovered while debugging OOM-kill failures on a manual-DTE GitHub Actions setup.