docs(sample): document band sample run in README and AGENTS.md - #54
Open
michaela-band wants to merge 2 commits into
Open
michaela-band wants to merge 2 commits into
michaela-band wants to merge 2 commits into
Conversation
Adds a Sample applications section to README.md covering band sample list and band sample run, with a focused walkthrough of the OpenAI live-assistant sample — prerequisites, step-by-step what happens, and the bring-your-own- API-key narrative. Also adds a Samples behavioral-notes entry to AGENTS.md clarifying that band sample run is human-facing (not agentic), that band sample list is safe for agent discovery, and how credentials and voice resources are auto-resolved. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
✅ 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. |
michaela-band
commented
Oct 2, 2026
Contributor
|
👍 |
kush2shah
approved these changes
Oct 2, 2026
ajrice6713
approved these changes
Oct 2, 2026
ckoegel
reviewed
Oct 2, 2026
Contributor
There was a problem hiding this comment.
we definitely need to document somewhere that this will only work for samples that support OAuth or customers are gonna be really confused when they try to run an app and it can't authenticate
Contributor
Author
There was a problem hiding this comment.
I agree with you but I didn't add any samples that don't support OAuth (I hope), and I was thinking we update each sample before adding it! That way we don't have info about basic auth, especially so close to the Dec 1st deadline for migrating
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
5 participants
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.
Summary
## Sample applicationssection to README.md with a full walkthrough ofband sample listandband sample run, centered on the OpenAI live-assistant sample### Samplesentry to the## Behavioral Notessection of AGENTS.md clarifying thatband sample runis human-facing (not agentic), what credentials are auto-wired vs. what requires explicit flags, and how voice resources are auto-resolvedband sample list/band sample runentries to the command reference table in README.mdKey narrative the README now surfaces: bring your AI provider's API key — Bandwidth supplies the phone network. The AGENTS.md note makes sure an agent helping a developer knows to hand off the command to the human rather than try to run it headlessly.
Test plan
## Sample applicationssection — prerequisites, numbered steps, and--transfer-tocallout are accurate relative tocmd/sample/catalog.goandcmd/sample/run.go### Samples— behavioral notes match what the code actually does (credential wiring, app nameband-sample-<name>, first-number selection)band sample --helpoutput🤖 Generated with Claude Code