Skip to content

docs: add agent setup and troubleshooting guide - #65

Merged
vsn411 merged 1 commit into
secfoo-com:mainfrom
dbdefault:docs/agent-setup-guide
Nov 10, 2026
Merged

vsn411 merged 1 commit into
secfoo-com:mainfrom
dbdefault:docs/agent-setup-guide

Conversation

@dbdefault

Copy link
Copy Markdown
Contributor

Closes #50

What

New docs/agents.md: per-agent setup (the argv secfoo builds, auth, model selection, read-only behavior) and a troubleshooting section (binary_not_found, auth/trust prompts, timeout, failed, API not_configured). Linked from README.md and docs/REFERENCE.md.

How the facts were sourced

Every command, flag, env var and failure message comes from src/secfoo/agents/*.py (adapters, docstrings, base.py); the stderr log location from CONTRIBUTING.md. Install and login commands the adapters do not state are explicitly marked "unverified" in the guide instead of guessed.

Notes

  • The OpenCode adapter (Add OpenCode agent adapter #63) is not on main yet, so it is not documented here; a row can be added after Add OpenCode agent adapter #63 merges.
  • Docs only. git diff --check and the relative links pass. pytest could not run in my environment (a missing global pytest plugin), and no code changed.

@vsn411
vsn411 merged commit aa182f3 into secfoo-com:main Nov 10, 2026
2 checks passed
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.

Docs: per-agent setup and troubleshooting guide

2 participants