Skip to content

DOCT-2703: Add snyk agent command reference - #1684

Draft
mihaisau-snyk wants to merge 3 commits into
mainfrom
docs/DOCT-2703-snyk-agent-command
Draft

DOCT-2703: Add snyk agent command reference#1684
mihaisau-snyk wants to merge 3 commits into
mainfrom
docs/DOCT-2703-snyk-agent-command

Conversation

@mihaisau-snyk

@mihaisau-snyk mihaisau-snyk commented Aug 25, 2026

Copy link
Copy Markdown
Collaborator

Adds initial documentation for the new experimental snyk agent command 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) and code-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.mdsnyk agent family page (mirrors container.md)
  • developer-tools/snyk-cli/commands/agent-test.mdsnyk agent test subcommand page (mirrors code-test.md)

Updated:

  • developer-tools/snyk-cli/commands/README.md — added snyk agent / snyk agent test to the commands index
  • developer-tools/SUMMARY.md — added both pages to the GitBook nav

Needs confirmation from engineering before this is ready for review:

  • Full flag/option list for snyk agent test (currently a placeholder callout, no options fabricated)
  • Exit codes for snyk agent test (drafted by analogy to other test commands — 0/1/2, not verified against the actual CLI)
  • Whether snyk agent (parent command) takes any options of its own
  • Confirmation this is scoped correctly — please review and flag anything missing, per the ask to @peter.schafer in #ask-cli

Note

Low Risk
Documentation-only change, no code or security impact.

Overview
Adds the first documentation for the new snyk agent experimental 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.

@snyk-io

snyk-io Bot commented Aug 25, 2026

Copy link
Copy Markdown

Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
Open Source Security 0 0 0 0 0 issues
Licenses 0 0 0 0 0 issues
Code Security 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

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