docs(cli): document agent / CI usage for deno deploy and deno sandbox#3180
Open
crowlbot wants to merge 3 commits into
Open
docs(cli): document agent / CI usage for deno deploy and deno sandbox#3180crowlbot wants to merge 3 commits into
crowlbot wants to merge 3 commits into
Conversation
Adds a dedicated 'Agent / CI usage' section to the deno deploy CLI reference covering the conventions that make non-interactive use reliable: token discovery order, the global --json / --non-interactive / --quiet / --debug / --token / --endpoint / --config flags, exit-code taxonomy (0/1/2/3/4/5/6), the structured error envelope on stderr in --json mode, the per-subcommand JSON output schemas, the non-interactive flag coverage table, stdio discipline, and copy-pasteable examples. Also fills out the previously incomplete 'Global options' (most global flags were undocumented) and splits root-command options from globals. Cross-links the same conventions from the deno sandbox CLI reference.
The standalone deno sandbox command does not expose --json / --non-interactive at the moment, and sandbox subcommands do not emit JSON. Stop claiming they do; note the gap as future work.
This was referenced Jun 1, 2026
Rewrap paragraphs and table column widths to match deno fmt output. Switch the NDJSON logs example from a json fence to a text fence so the single-record-per-line shape is preserved (fmt pretty-prints any json block).
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.
Summary
Documents the conventions that make
deno deployanddeno sandboxreliable to drive from CI pipelines and AI agents (Claude Code, Cursor, etc.) without a human at the terminal. These conventions already exist in the CLI as of @deno/deploy 0.0.99 (see denoland/deploy-cli #91-#95) but are not yet documented anywhere users can find them.Two files touched:
runtime/reference/cli/deploy.md— adds a dedicated Agent / CI usage section, and fills out the previously incomplete Global options section.runtime/reference/cli/sandbox.md— adds--json/--non-interactive/--quiet/--debug/--endpointto its Global options list and cross-links the new section.What's in the new section
DENO_DEPLOY_TOKEN),--tokenflag, keychain priority order; the "never opens a browser" guarantee when a token is supplied explicitly. (Expanded the existing Authentication section.)--json,--non-interactive(-y),--quiet(-q),--debug,--token,--endpoint,--config,--ignore. Previously the page only listed--help,--org,--app,--prodand conflated root-command options with truly global ones.--jsonmode (code,message,hint,traceId).--non-interactive— per-subcommand table.whoami,orgs list,apps list,deployments list,env list,database list,database query,publish,create(both--dry-runand GitHub source),logs(NDJSON).Background
This content originally landed (incorrectly) as
AGENTS.mdin denoland/deploy-cli #96. That repo is invisible to people runningdeno deploy; the canonical home is the CLI reference page here. The deploy-cli PR is being closed in favor of this one (plus a small companion PR to the deploy-cli that expandsdeno deploy --helpitself).Test plan
CI (
deno fmt --check+ Lume build + link checker) covers this PR. No code paths touched.