DOCT-2703: Add snyk agent command reference - #1684
Draft
mihaisau-snyk wants to merge 3 commits into
Draft
Conversation
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
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
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.
Adds initial documentation for the new experimental
snyk agentcommand space, shipping in Snyk CLI v1.1307.0 (releasing Aug 26). Confirmed present in the private RC build by Roberto Lopez Lopez (snyk/cli#7152). Raised per the discussion in #ask-cli on DOCT-2703.Rewritten to follow the internal CLI command page template (H1 Title Case with no "Snyk" prefix, standard H2 order — Prerequisites → Usage → Description → Exit codes → Configure the Snyk CLI → Code execution warning → Debug → Options → Examples, standard boilerplate blocks for "Configure the Snyk CLI" / "Code execution warning" / "Debug"), matching the pattern used in
container.md(family page) andcode-test.md(full command page).This is a starting skeleton, not a final page — flagging below what still needs input from engineering before this is ready for review.
New pages:
developer-tools/snyk-cli/commands/agent.md—snyk agentfamily page (mirrorscontainer.md)developer-tools/snyk-cli/commands/agent-test.md—snyk agent testsubcommand page (mirrorscode-test.md)Updated:
developer-tools/snyk-cli/commands/README.md— addedsnyk agent/snyk agent testto the commands indexdeveloper-tools/SUMMARY.md— added both pages to the GitBook navNeeds confirmation from engineering before this is ready for review:
snyk agent test(currently a placeholder callout, no options fabricated)snyk agent test(drafted by analogy to other test commands — 0/1/2, not verified against the actual CLI)snyk agent(parent command) takes any options of its ownNote
Low Risk
Documentation-only change, no code or security impact.
Overview
Adds the first documentation for the new
snyk agentexperimental command space introduced in Snyk CLI v1.1307.0, built to the internal CLI command page template. Creates a family page (agent.md) and a subcommand page (agent-test.md) following the same structure and boilerplate sections used across existing command docs, and wires both into the CLI commands index and GitBook navigation. Content is a starting skeleton pending flag/option and exit-code confirmation from the Agent-optimized CLI team.