feat(help): mention agent / CI conventions in root --help#100
Open
crowlbot wants to merge 1 commit into
Open
Conversation
Expand the deno deploy root description so deno deploy --help itself points users at DENO_DEPLOY_TOKEN, --json + --non-interactive, the exit code taxonomy, and the canonical reference page on docs.deno.com. Add three .example() entries to the deploy command for the most common agent flows: whoami, non-interactive publish, non-interactive create. For deno sandbox, the standalone command does not yet wire up --json / --non-interactive globally, so the description only documents the DENO_DEPLOY_TOKEN escape hatch and points at the docs reference.
4 tasks
crowlKats
approved these changes
Jun 1, 2026
Contributor
Author
|
The remaining The Happy to re-run once more if you'd like to wait for green, otherwise this should be safe to admin-merge. |
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.
Summary
Make
deno deploy --helpitself surface the agent/CI conventions that landed in #91-#95. Today the global--json,--non-interactive,--tokenand theDENO_DEPLOY_TOKENenv var are all individually documented in--helpline items, but the root command description gives no hint that they exist as a coherent agent-mode contract or that there's a stable exit-code taxonomy.Tiny change:
deploy/mod.ts— expanddeployCommand.description()to mentionDENO_DEPLOY_TOKEN, the recommended--json --non-interactiveinvocation, the exit-code taxonomy (0–6), and the structured error envelope. Link todocs.deno.com/runtime/reference/cli/deploy/#agent--ci-usagefor the full reference.deploy/mod.ts— add three.example()entries for the most common agent flows:whoami --json, non-interactive publish, non-interactivecreate.sandbox/mod.ts— expandsandboxCommand.description()to document theDENO_DEPLOY_TOKENescape hatch and link to the sandbox reference. (Intentionally does not advertise--json/--non-interactivefor sandbox, because the standalonedeno sandboxcommand doesn't currently expose those as globals — a separate gap for a follow-up.)Why root-description and not per-subcommand
--helplistings are dense; per-flag descriptions don't compose into a story about "how do I drive this from a bot." A 6-line prose paragraph at the top of the root command's description is the natural place to set that context, alongside a few.example()entries that the agent can pattern-match.Test plan
deno fmt,deno lint,deno check main.ts,deno test -A— CI runs all four. No behavior change; only--helptext.Companion
The canonical reference URL this links to is being added in denoland/docs#3180.