docs: cover AI SDK flag and background job polling in CLI#11357
docs: cover AI SDK flag and background job polling in CLI#11357fahe1em1 wants to merge 1 commit intocontinuedev:mainfrom
Conversation
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: ca7b97c6c9
ℹ️ 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".
|
|
||
| ## Background jobs | ||
|
|
||
| If a shell command is moved to the background, Continue returns a job id and the output collected so far. The agent can then call `CheckBackgroundJob("<job-id>")` to fetch the current status, exit code, and accumulated output while the job continues running. |
There was a problem hiding this comment.
Clarify headless background-job polling prerequisite
This headless-mode section describes a polling flow that cannot currently be initiated in cn -p runs: Bash only returns a Continue job id when runTerminalCommand receives a backgroundRequested signal, and the only signal source in the repo is the Ctrl+B TUI input handler (extensions/cli/src/ui/hooks/useUserInput.ts). In headless CI usage there is no interactive key handler, so commands cannot be moved into Continue-managed background jobs and users will not get the job id needed for CheckBackgroundJob polling.
Useful? React with 👍 / 👎.
Description
Partially addresses #10997.
This documents the remaining CLI docs gaps around the
CONTINUE_USE_AI_SDKenvironment variable and the defaultCheckBackgroundJobflow for backgrounded shell work. It adds an advanced configuration note explaining that the flag routesopenaiandanthropicproviders through Continue's AI SDK adapter, and it adds headless-mode guidance thatCheckBackgroundJobstays allow-by-default and can be used to poll background jobs. The change is intentionally small and safe because it only updates two existing docs pages and does not alter runtime behavior.Checklist
Tests
npx --yes prettier --check --no-config --tab-width 2 --use-tabs false --trailing-comma all --semi true --single-quote false --bracket-spacing true docs/cli/configuration.mdx docs/cli/headless-mode.mdxprintf 'continue\\n' | npx mintlify broken-links(currently fails in the repo on a pre-existing parse error inextensions/cli/BUILD.md, not on these updated pages)Why this is small and safe
Summary by cubic
Adds CLI docs for
CONTINUE_USE_AI_SDKand for polling backgrounded shell jobs, addressing gaps from #10997. SettingCONTINUE_USE_AI_SDK=1routesopenaiandanthropicvia Continue’s Vercel AI SDK adapter; headless mode docs now note that backgrounded commands return a job id and can be polled withCheckBackgroundJob, with read-only helpers allowed by default.Written for commit ca7b97c. Summary will update on new commits.