Send a task to the cloud

Know what is ready

Note: Cloud agents are a preview. The full lifecycle is covered by offline tests, but the live path — a real sandbox and a real pull request on each forge — has not been verified end to end yet. Private repositories are not supported yet.

Before you start

• Sign in to your Codewhale account with codewhale login. Without it, a task can be proposed but not confirmed.
• Make an account API key available as CODEWHALE_API_KEY, so the agent in the sandbox runs as your account. Without it, confirming is refused before anything is spent.
• For GitHub, be signed in to the gh command-line tool; Codewhale uses that login to open the pull request.

codewhale dispatch --status

--status shows the forges found in your git remotes and whether the required credentials are present. It never prints a secret.

Propose, then confirm

codewhale dispatch "fix the flaky login test and open a PR" --remote github
codewhale dispatch --confirm cloud_<id>

The first command only writes a proposal and prints its id. The second starts it. Codewhale may propose a cloud task on its own, but it never confirms one. In a session, use /dispatch <task> and /dispatch confirm <id>.

Once confirmed, the agent clones the repository into a new sandbox, does the work, pushes a new branch (never a force-push), and opens the pull request. The sandbox is deleted when the job finishes, fails, or is cancelled.

Track or cancel a job

codewhale dispatch --list
codewhale dispatch --show cloud_<id>
codewhale dispatch --cancel cloud_<id>

Cloud jobs also appear in /jobs. A job shows its progress, the branch, the pull request link once one exists, and how many minutes it ran — a runtime figure, not a bill. Cancelling tears the sandbox down right away.

Choose where the pull request goes

Codewhale supports GitHub, CNB, and Gitee, and never assumes origin is GitHub. A remote named github, cnb, or gitee is that forge; any other remote is identified by its host. If your repository has more than one forge, pass --remote.

If a pull request cannot be opened — for example, a forge token is missing — the job is marked failed after the push and says that no pull request was opened. It never reports a link it does not have.

Next