feat(cli): default --wait in non-interactive mode, slim init --help#11
feat(cli): default --wait in non-interactive mode, slim init --help#11caffeinum wants to merge 3 commits into
Conversation
Based on eval trace sanity-22a3b1e3 analysis: - Make `--wait` default to true when stdout is not a TTY (CI, agents), unless --with-token is used. Pass --no-wait to opt out. Agents no longer have to discover the flag and guess `sleep 15` cycles. - Slim `sanity init --help` by hiding niche flags (coupon, project-plan, mcp, import-dataset, overwrite-files) and adding a "Common usage" block to the command description. Surfaces the typical workflow before the full flag list. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
|
Claude encountered an error —— View job I'll analyze this and get back to you. |
📦 Bundle Stats —
|
| Metric | Value | vs fix/organisations-list (2d656d7) |
|---|---|---|
| Internal (raw) | 2.1 KB | - |
| Internal (gzip) | 799 B | - |
| Bundled (raw) | 10.97 MB | - |
| Bundled (gzip) | 2.06 MB | - |
| Import time | 832ms | +0ms, +0.0% |
bin:sanity
| Metric | Value | vs fix/organisations-list (2d656d7) |
|---|---|---|
| Internal (raw) | 1023 B | - |
| Internal (gzip) | 486 B | - |
| Bundled (raw) | 9.84 MB | - |
| Bundled (gzip) | 1.77 MB | - |
| Import time | 935ms | -4ms, -0.5% |
🗺️ View treemap · Artifacts
Details
- Import time regressions over 10% are flagged with
⚠️ - Sizes shown as raw / gzip 🗜️. Internal bytes = own code only. Total bytes = with all dependencies. Import time = Node.js cold-start median.
📦 Bundle Stats — @sanity/cli-core
Compared against fix/organisations-list (2d656d71)
| Metric | Value | vs fix/organisations-list (2d656d7) |
|---|---|---|
| Internal (raw) | 96.5 KB | - |
| Internal (gzip) | 22.7 KB | - |
| Bundled (raw) | 21.61 MB | - |
| Bundled (gzip) | 3.42 MB | - |
| Import time | 796ms | +1ms, +0.1% |
🗺️ View treemap · Artifacts
Details
- Import time regressions over 10% are flagged with
⚠️ - Sizes shown as raw / gzip 🗜️. Internal bytes = own code only. Total bytes = with all dependencies. Import time = Node.js cold-start median.
📦 Bundle Stats — create-sanity
Compared against fix/organisations-list (2d656d71)
| Metric | Value | vs fix/organisations-list (2d656d7) |
|---|---|---|
| Internal (raw) | 908 B | - |
| Internal (gzip) | 483 B | - |
| Bundled (raw) | 931 B | - |
| Bundled (gzip) | 491 B | - |
| Import time | ❌ ChildProcess denied: node | - |
Details
- Import time regressions over 10% are flagged with
⚠️ - Sizes shown as raw / gzip 🗜️. Internal bytes = own code only. Total bytes = with all dependencies. Import time = Node.js cold-start median.
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: a241b0466b
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| const effectiveWait = | ||
| typeof flags.wait === 'boolean' ? flags.wait : !isInteractive() && !withToken |
There was a problem hiding this comment.
When non-interactive sanity login is run without --wait/--no-wait and the config already contains an invalid or expired authToken, this new default enters the wait loop after login() has already called getCliToken(), seeding the parent process token cache with the stale token. The background child writes the new token in a separate process, so it cannot clear the parent's cache; subsequent validateSession() calls keep checking the old token and the command times out after 5 minutes even though OAuth completed. Clear the CLI token cache or read the config fresh before/during the wait loop.
Useful? React with 👍 / 👎.
caffeinum
added
the
trigger: preview
Preview this PR with pkg.pr.newRun the Sanity CLInpx https://pkg.pr.new/team2027/sanity-cli/@sanity/cli@da272cd <command>...Or upgrade project dependencies📦
|
2027 // Getting Started: Staging CLI — C 63.3/100+ █████████████░░░░░░░ ▲ +5 pts vs baseline
Tested: example.com → daytona.io Commit |
The background login child writes the new token to disk in a separate process, so it cannot invalidate the parent process's in-memory token cache. If the parent had an existing (stale/expired) token at startup, `getCliToken()` returns the cached stale value indefinitely and the wait loop times out after 5 minutes even though OAuth completed. Call clearCliTokenCache() before each validateSession() iteration in both the login --wait loop and the initAction auto-login polling, so the next call re-reads from disk. Reported by CodeRabbit on PR #11. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: f3a5c2ed80
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| // so agents and CI get a deterministic exit code without having to discover | ||
| // the flag. Pass `--no-wait` to opt out. | ||
| const effectiveWait = | ||
| typeof flags.wait === 'boolean' ? flags.wait : !isInteractive() && !withToken |
There was a problem hiding this comment.
In non-interactive sanity login without --wait/--no-wait, oclif boolean flags still parse as false when omitted (the Flags.boolean implementation documents that booleans default to false unless defaulted true), so typeof flags.wait === 'boolean' is always true and effectiveWait becomes false instead of falling through to !isInteractive() && !withToken. This means the new advertised default never applies for agents/CI unless they still discover and pass --wait, preserving the old immediate-return behavior and making --no-wait indistinguishable from omission.
Useful? React with 👍 / 👎.
… --help Two small AX wins from eval trace sanity-95d47728: - `sanity tokens add` now prints a copy-pasteable `SANITY_API_TOKEN=...` env line after the token. Agents commonly created a token then wrote a seed script with raw `@sanity/client` — the env name nudge skips one round of "what should I name this var?". - `sanity init --help` now includes `cd my-studio && sanity typegen generate` as an example. In the eval trace the agent hand-wrote a TypeScript interface mirroring the schema; typegen would have generated it (and kept it in sync). Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Coverage Delta
Comparing 23 changed files against main @ Overall Coverage
|
1 participant
Description
Based on analysis of eval trace
sanity-22a3b1e3, two small AX improvements that cut wall-clock time and token cost without new commands.Stacked on
fix/organisations-list— depends on the--waitflag added there.Changes
1.
--waitdefaults to true in non-interactive modeThe flag exists (added in #10) but agents have to discover it from
--helpand then opt in. The trace shows the agent wrotesleep 15 && sanity auth statusinstead of using--wait, costing ~22 seconds of idle time.Flags.boolean({allowNo: true})(no static default)effectiveWait = typeof flags.wait === 'boolean' ? flags.wait : !isInteractive() && !withToken--no-waitexplicitly opts out--with-tokendoesn't trigger wait (token from stdin)2. Slim
sanity init --helpThe 80-line flag dump in the trace cost tokens and didn't even surface
--organizationuntil the agent hit an error.coupon,project-plan,mcp,import-dataset,overwrite-filesWhat to review
packages/@sanity/cli/src/commands/login.ts—effectiveWaitresolutionpackages/@sanity/cli/src/commands/init.ts— description block + hidden flagspackages/@sanity/cli/src/commands/__tests__/login.test.ts— two non-interactive tests now pass--no-waitto keep their original assertions validTesting
--waitmocking infra; could add an explicit positive test later)🤖 Generated with Claude Code