* I've completed the implementation. Here's a summary of the changes made:
## Summary
### Backend (Rust)
1. **`crates/services/src/services/config/versions/v8.rs`**
- Added two new config fields:
- `pr_auto_description_enabled: bool` - defaults to `false`
- `pr_auto_description_prompt: Option<String>` - defaults to `None`
2. **`crates/server/src/routes/task_attempts.rs`**
- Added `auto_generate_description: bool` field to `CreateGitHubPrRequest`
- Added `DEFAULT_PR_DESCRIPTION_PROMPT` constant with the default prompt
- Added `trigger_pr_description_follow_up()` helper function that:
- Gets the custom prompt from config or uses default
- Replaces `{pr_number}` and `{pr_url}` placeholders
- Triggers a follow-up (or initial if no session) coding agent execution
- Modified `create_github_pr()` to call the follow-up trigger after successful PR creation
### Frontend (TypeScript/React)
3. **`frontend/src/components/dialogs/tasks/CreatePRDialog.tsx`**
- Added `autoGenerateDescription` state, initialized from `config.pr_auto_description_enabled`
- Added checkbox to toggle auto-generate PR description
- Included `auto_generate_description` in the API call payload
4. **`frontend/src/pages/settings/GeneralSettings.tsx`**
- Added "Pull Requests" Card section with:
- Checkbox to enable/disable auto-generate by default
- Textarea for custom prompt override
5. **Translation files**
- Added `autoGenerateLabel` to `tasks.json`
- Added `pullRequests` section to `settings.json`
6. **`shared/types.ts`** - Auto-generated with new types
### Key Features
- Toggle in PR creation dialog, defaulting to the global config setting
- Settings page for configuring default behavior and custom prompt
- Placeholders `{pr_number}` and `{pr_url}` for custom prompts
- Uses the same executor profile as the original task attempt
- Graceful error handling (warns but doesn't fail PR creation if follow-up fails)
* Cleanup script changes for task attempt 46e66dfc-f608-47a4-baca-e38399d2da15
* Done! I've updated the placeholder text in `settings.json` to show the actual default prompt. Now users can see exactly what prompt the AI agent will use by default, and they know what they're customizing when they enter a custom prompt.
The placeholder now shows:
```
Update the GitHub PR that was just created with a better title and description.
The PR number is #{pr_number} and the URL is {pr_url}.
Analyze the changes in this branch and write:
1. A concise, descriptive title that summarizes the changes
2. A detailed description that explains:
- What changes were made
- Why they were made (based on the task context)
- Any important implementation details
Use `gh pr edit` to update the PR.
```
I also updated the helper text to mention the placeholder variables (`{pr_number}` and `{pr_url}`) so users know what variables they can use in their custom prompts.
* Cleanup script changes for task attempt 46e66dfc-f608-47a4-baca-e38399d2da15
* Done! Updated the label to "Ask AI agent to generate a better PR description" as requested.
* All done! The refactoring is complete:
**Summary of changes:**
1. **Created `crates/server/src/routes/task_attempts/pr.rs`** - New submodule containing all PR-related code:
- Types: `CreateGitHubPrRequest`, `CreatePrError`, `AttachPrResponse`, `PrCommentsResponse`, `GetPrCommentsError`
- Constants: `DEFAULT_PR_DESCRIPTION_PROMPT`
- Functions: `trigger_pr_description_follow_up`, `create_github_pr`, `attach_existing_pr`, `get_pr_comments`
2. **Updated `crates/server/src/routes/task_attempts.rs`** - Added `pub mod pr;` and updated router to use `pr::` prefix for PR routes
3. **Updated `crates/server/src/bin/generate_types.rs`** - Fixed all paths to reference `pr::` submodule for the PR-related types
Both backend (cargo check) and frontend (TypeScript) compile successfully, and TypeScript types have been regenerated.
* Cleanup script changes for task attempt 46e66dfc-f608-47a4-baca-e38399d2da15
* Done! I've updated the default PR description prompt in both locations:
1. **`crates/server/src/routes/task_attempts/pr.rs`** - Updated `DEFAULT_PR_DESCRIPTION_PROMPT` constant
2. **`frontend/src/i18n/locales/en/settings.json`** - Updated `pullRequests.customPrompt.placeholder`
The changes are:
- Title should now be postfixed with "(Vibe Kanban)"
- Description should include a note at the end: "This PR was written using [Vibe Kanban](https://vibekanban.com)"
* Done! I've updated `pr_auto_description_enabled` to default to `true` in three places:
1. Added `default_pr_auto_description_enabled()` function that returns `true`
2. Updated the `#[serde(default)]` attribute to use this function
3. Updated the `from_v7_config` migration to set it to `true`
4. Updated the `Default` impl to set it to `true`
* All done! I've added i18n translations for the PR auto-description feature to all supported languages:
**settings.json** - Added `pullRequests` section with:
- `title`, `description`
- `autoDescription.label`, `autoDescription.helper`
- `customPrompt.label`, `customPrompt.placeholder`, `customPrompt.helper`
**tasks.json** - Added `autoGenerateLabel` key
Languages updated:
- Spanish (es)
- Japanese (ja)
- Korean (ko)
- Simplified Chinese (zh-Hans)
* Update frontend/src/i18n/locales/en/tasks.json
Co-authored-by: Gabriel Gordon-Hall <gabriel@bloop.ai>
* Done! I've implemented the UX improvement from the PR review:
1. **Moved the auto-generate checkbox** to the top of the form (above title and description)
2. **Added `disabled` prop** to both the title Input and description Textarea when `autoGenerateDescription` is true
3. **Added greyed-out styling** (`opacity-50 cursor-not-allowed`) to visually indicate the fields are disabled
The new field order is:
1. Auto-generate checkbox
2. Title input (disabled when checked)
3. Description textarea (disabled when checked)
4. Base branch selector
5. Draft checkbox
* All done! I've:
1. **Made `DEFAULT_PR_DESCRIPTION_PROMPT` public** in `pr.rs`
2. **Exported the constant to `shared/types.ts`** via `generate_types.rs`:
- Imported the constant from the pr module
- Added code to append `export const DEFAULT_PR_DESCRIPTION_PROMPT = \`...\`;` to the generated types
3. **Updated `GeneralSettings.tsx`** to import and use the constant directly as the placeholder
4. **Removed the duplicate `placeholder` key** from all i18n `settings.json` files (en, es, ja, ko, zh-Hans)
The default prompt is now defined in a single place (the Rust backend) and exported to TypeScript, eliminating duplication across all i18n files.
* Cleanup script changes for task attempt 46e66dfc-f608-47a4-baca-e38399d2da15
* Done! I've implemented the two-step UX for the custom prompt:
1. **Updated `GeneralSettings.tsx`**:
- Replaced the always-visible textarea with a "Use custom prompt" checkbox
- When checked, pre-fills the textarea with `DEFAULT_PR_DESCRIPTION_PROMPT`
- When unchecked, sets `pr_auto_description_prompt` to `null` (reverts to default)
- Textarea only visible when custom prompt is enabled
2. **Updated i18n files** (all 5 languages):
- Replaced `label` with `useCustom` key
- Updated `helper` text to remove "Leave empty to use the default" since that's now handled by the checkbox
- Added translations:
- **en**: "Use custom prompt"
- **es**: "Usar prompt personalizado"
- **ja**: "カスタムプロンプトを使用"
- **ko**: "사용자 정의 프롬프트 사용"
- **zh-Hans**: "使用自定义提示"
* Done! The custom prompt UX has been updated:
- **Textarea is now always visible** showing the current prompt (default or custom)
- **When "Use custom prompt" is unchecked**: textarea shows `DEFAULT_PR_DESCRIPTION_PROMPT` but is disabled/read-only with greyed-out styling
- **When "Use custom prompt" is checked**: textarea becomes editable, pre-filled with the default prompt for customization
This gives users visibility into what prompt will be used even when using the default, while still allowing them to customize it by checking the checkbox.
* Cleanup script changes for task attempt 46e66dfc-f608-47a4-baca-e38399d2da15
* Done! The fix has been applied. Now when the "Use custom prompt" checkbox is checked, users can:
- Clear all the text in the textarea to start from scratch
- The text no longer automatically reverts to the default prompt when emptied
---------
Co-authored-by: Gabriel Gordon-Hall <gabriel@bloop.ai>
454 lines
27 KiB
TypeScript
454 lines
27 KiB
TypeScript
// This file was generated by `crates/core/src/bin/generate_types.rs`.
|
|
|
|
// Do not edit this file manually.
|
|
|
|
// If you are an AI, and you absolutely have to edit this file, please confirm with the user first.
|
|
|
|
export type SharedTaskResponse = { task: SharedTask, user: UserData | null, };
|
|
|
|
export type AssigneesQuery = { project_id: string, };
|
|
|
|
export type SharedTask = { id: string, organization_id: string, project_id: string, creator_user_id: string | null, assignee_user_id: string | null, deleted_by_user_id: string | null, title: string, description: string | null, status: TaskStatus, deleted_at: string | null, shared_at: string | null, created_at: string, updated_at: string, };
|
|
|
|
export type UserData = { user_id: string, first_name: string | null, last_name: string | null, username: string | null, };
|
|
|
|
export type Project = { id: string, name: string, git_repo_path: string, setup_script: string | null, dev_script: string | null, cleanup_script: string | null, copy_files: string | null, parallel_setup_script: boolean, remote_project_id: string | null, created_at: Date, updated_at: Date, };
|
|
|
|
export type CreateProject = { name: string, git_repo_path: string, use_existing_repo: boolean, setup_script: string | null, dev_script: string | null, cleanup_script: string | null, copy_files: string | null, parallel_setup_script: boolean | null, };
|
|
|
|
export type UpdateProject = { name: string | null, git_repo_path: string | null, setup_script: string | null, dev_script: string | null, cleanup_script: string | null, copy_files: string | null, parallel_setup_script: boolean | null, };
|
|
|
|
export type SearchResult = { path: string, is_file: boolean, match_type: SearchMatchType, };
|
|
|
|
export type SearchMatchType = "FileName" | "DirectoryName" | "FullPath";
|
|
|
|
export type Tag = { id: string, tag_name: string, content: string, created_at: string, updated_at: string, };
|
|
|
|
export type CreateTag = { tag_name: string, content: string, };
|
|
|
|
export type UpdateTag = { tag_name: string | null, content: string | null, };
|
|
|
|
export type TaskStatus = "todo" | "inprogress" | "inreview" | "done" | "cancelled";
|
|
|
|
export type Task = { id: string, project_id: string, title: string, description: string | null, status: TaskStatus, parent_task_attempt: string | null, shared_task_id: string | null, created_at: string, updated_at: string, };
|
|
|
|
export type TaskWithAttemptStatus = { has_in_progress_attempt: boolean, has_merged_attempt: boolean, last_attempt_failed: boolean, executor: string, id: string, project_id: string, title: string, description: string | null, status: TaskStatus, parent_task_attempt: string | null, shared_task_id: string | null, created_at: string, updated_at: string, };
|
|
|
|
export type TaskRelationships = { parent_task: Task | null, current_attempt: TaskAttempt, children: Array<Task>, };
|
|
|
|
export type CreateTask = { project_id: string, title: string, description: string | null, status: TaskStatus | null, parent_task_attempt: string | null, image_ids: Array<string> | null, shared_task_id: string | null, };
|
|
|
|
export type UpdateTask = { title: string | null, description: string | null, status: TaskStatus | null, parent_task_attempt: string | null, image_ids: Array<string> | null, };
|
|
|
|
export type DraftFollowUpData = { message: string, variant: string | null, };
|
|
|
|
export type ScratchPayload = { "type": "DRAFT_TASK", "data": string } | { "type": "DRAFT_FOLLOW_UP", "data": DraftFollowUpData };
|
|
|
|
export enum ScratchType { DRAFT_TASK = "DRAFT_TASK", DRAFT_FOLLOW_UP = "DRAFT_FOLLOW_UP" }
|
|
|
|
export type Scratch = { id: string, payload: ScratchPayload, created_at: string, updated_at: string, };
|
|
|
|
export type CreateScratch = { payload: ScratchPayload, };
|
|
|
|
export type UpdateScratch = { payload: ScratchPayload, };
|
|
|
|
export type Image = { id: string, file_path: string, original_name: string, mime_type: string | null, size_bytes: bigint, hash: string, created_at: string, updated_at: string, };
|
|
|
|
export type CreateImage = { file_path: string, original_name: string, mime_type: string | null, size_bytes: bigint, hash: string, };
|
|
|
|
export type TaskAttempt = { id: string, task_id: string, container_ref: string | null, branch: string, target_branch: string, executor: string, worktree_deleted: boolean, setup_completed_at: string | null, created_at: string, updated_at: string, };
|
|
|
|
export type ExecutionProcess = { id: string, task_attempt_id: string, run_reason: ExecutionProcessRunReason, executor_action: ExecutorAction,
|
|
/**
|
|
* Git HEAD commit OID captured before the process starts
|
|
*/
|
|
before_head_commit: string | null,
|
|
/**
|
|
* Git HEAD commit OID captured after the process ends
|
|
*/
|
|
after_head_commit: string | null, status: ExecutionProcessStatus, exit_code: bigint | null,
|
|
/**
|
|
* dropped: true if this process is excluded from the current
|
|
* history view (due to restore/trimming). Hidden from logs/timeline;
|
|
* still listed in the Processes tab.
|
|
*/
|
|
dropped: boolean, started_at: string, completed_at: string | null, created_at: string, updated_at: string, };
|
|
|
|
export enum ExecutionProcessStatus { running = "running", completed = "completed", failed = "failed", killed = "killed" }
|
|
|
|
export type ExecutionProcessRunReason = "setupscript" | "cleanupscript" | "codingagent" | "devserver";
|
|
|
|
export type Merge = { "type": "direct" } & DirectMerge | { "type": "pr" } & PrMerge;
|
|
|
|
export type DirectMerge = { id: string, task_attempt_id: string, merge_commit: string, target_branch_name: string, created_at: string, };
|
|
|
|
export type PrMerge = { id: string, task_attempt_id: string, created_at: string, target_branch_name: string, pr_info: PullRequestInfo, };
|
|
|
|
export type MergeStatus = "open" | "merged" | "closed" | "unknown";
|
|
|
|
export type PullRequestInfo = { number: bigint, url: string, status: MergeStatus, merged_at: string | null, merge_commit_sha: string | null, };
|
|
|
|
export type ApprovalStatus = { "status": "pending" } | { "status": "approved" } | { "status": "denied", reason?: string, } | { "status": "timed_out" };
|
|
|
|
export type CreateApprovalRequest = { tool_name: string, tool_input: JsonValue, tool_call_id: string, };
|
|
|
|
export type ApprovalResponse = { execution_process_id: string, status: ApprovalStatus, };
|
|
|
|
export type Diff = { change: DiffChangeKind, oldPath: string | null, newPath: string | null, oldContent: string | null, newContent: string | null,
|
|
/**
|
|
* True when file contents are intentionally omitted (e.g., too large)
|
|
*/
|
|
contentOmitted: boolean,
|
|
/**
|
|
* Optional precomputed stats for omitted content
|
|
*/
|
|
additions: number | null, deletions: number | null, };
|
|
|
|
export type DiffChangeKind = "added" | "deleted" | "modified" | "renamed" | "copied" | "permissionChange";
|
|
|
|
export type ApiResponse<T, E = T> = { success: boolean, data: T | null, error_data: E | null, message: string | null, };
|
|
|
|
export type LoginStatus = { "status": "loggedout" } | { "status": "loggedin", profile: ProfileResponse, };
|
|
|
|
export type ProfileResponse = { user_id: string, username: string | null, email: string, providers: Array<ProviderProfile>, };
|
|
|
|
export type ProviderProfile = { provider: string, username: string | null, display_name: string | null, email: string | null, avatar_url: string | null, };
|
|
|
|
export type StatusResponse = { logged_in: boolean, profile: ProfileResponse | null, degraded: boolean | null, };
|
|
|
|
export enum MemberRole { ADMIN = "ADMIN", MEMBER = "MEMBER" }
|
|
|
|
export enum InvitationStatus { PENDING = "PENDING", ACCEPTED = "ACCEPTED", DECLINED = "DECLINED", EXPIRED = "EXPIRED" }
|
|
|
|
export type Organization = { id: string, name: string, slug: string, is_personal: boolean, created_at: string, updated_at: string, };
|
|
|
|
export type OrganizationWithRole = { id: string, name: string, slug: string, is_personal: boolean, created_at: string, updated_at: string, user_role: MemberRole, };
|
|
|
|
export type ListOrganizationsResponse = { organizations: Array<OrganizationWithRole>, };
|
|
|
|
export type GetOrganizationResponse = { organization: Organization, user_role: string, };
|
|
|
|
export type CreateOrganizationRequest = { name: string, slug: string, };
|
|
|
|
export type CreateOrganizationResponse = { organization: OrganizationWithRole, };
|
|
|
|
export type UpdateOrganizationRequest = { name: string, };
|
|
|
|
export type Invitation = { id: string, organization_id: string, invited_by_user_id: string | null, email: string, role: MemberRole, status: InvitationStatus, token: string, created_at: string, expires_at: string, };
|
|
|
|
export type CreateInvitationRequest = { email: string, role: MemberRole, };
|
|
|
|
export type CreateInvitationResponse = { invitation: Invitation, };
|
|
|
|
export type ListInvitationsResponse = { invitations: Array<Invitation>, };
|
|
|
|
export type GetInvitationResponse = { id: string, organization_slug: string, role: MemberRole, expires_at: string, };
|
|
|
|
export type AcceptInvitationResponse = { organization_id: string, organization_slug: string, role: MemberRole, };
|
|
|
|
export type RevokeInvitationRequest = { invitation_id: string, };
|
|
|
|
export type OrganizationMember = { user_id: string, role: MemberRole, joined_at: string, };
|
|
|
|
export type OrganizationMemberWithProfile = { user_id: string, role: MemberRole, joined_at: string, first_name: string | null, last_name: string | null, username: string | null, email: string | null, avatar_url: string | null, };
|
|
|
|
export type ListMembersResponse = { members: Array<OrganizationMemberWithProfile>, };
|
|
|
|
export type UpdateMemberRoleRequest = { role: MemberRole, };
|
|
|
|
export type UpdateMemberRoleResponse = { user_id: string, role: MemberRole, };
|
|
|
|
export type RemoteProject = { id: string, organization_id: string, name: string, metadata: Record<string, unknown>, created_at: string, };
|
|
|
|
export type ListProjectsResponse = { projects: Array<RemoteProject>, };
|
|
|
|
export type RemoteProjectMembersResponse = { organization_id: string, members: Array<OrganizationMemberWithProfile>, };
|
|
|
|
export type CreateRemoteProjectRequest = { organization_id: string, name: string, };
|
|
|
|
export type LinkToExistingRequest = { remote_project_id: string, };
|
|
|
|
export type TagSearchParams = { search: string | null, };
|
|
|
|
export type TokenResponse = { access_token: string, expires_at: string | null, };
|
|
|
|
export type UserSystemInfo = { config: Config, analytics_user_id: string, login_status: LoginStatus, environment: Environment,
|
|
/**
|
|
* Capabilities supported per executor (e.g., { "CLAUDE_CODE": ["SESSION_FORK"] })
|
|
*/
|
|
capabilities: { [key in string]?: Array<BaseAgentCapability> }, executors: { [key in BaseCodingAgent]?: ExecutorConfig }, };
|
|
|
|
export type Environment = { os_type: string, os_version: string, os_architecture: string, bitness: string, };
|
|
|
|
export type McpServerQuery = { executor: BaseCodingAgent, };
|
|
|
|
export type UpdateMcpServersBody = { servers: { [key in string]?: JsonValue }, };
|
|
|
|
export type GetMcpServerResponse = { mcp_config: McpConfig, config_path: string, };
|
|
|
|
export type CheckEditorAvailabilityQuery = { editor_type: EditorType, };
|
|
|
|
export type CheckEditorAvailabilityResponse = { available: boolean, };
|
|
|
|
export type CheckAgentAvailabilityQuery = { executor: BaseCodingAgent, };
|
|
|
|
export type CurrentUserResponse = { user_id: string, };
|
|
|
|
export type CreateFollowUpAttempt = { prompt: string, variant: string | null, retry_process_id: string | null, force_when_dirty: boolean | null, perform_git_reset: boolean | null, };
|
|
|
|
export type ChangeTargetBranchRequest = { new_target_branch: string, };
|
|
|
|
export type ChangeTargetBranchResponse = { new_target_branch: string, status: [number, number], };
|
|
|
|
export type RenameBranchRequest = { new_branch_name: string, };
|
|
|
|
export type RenameBranchResponse = { branch: string, };
|
|
|
|
export type CommitCompareResult = { subject: string, head_oid: string, target_oid: string, ahead_from_head: number, behind_from_head: number, is_linear: boolean, };
|
|
|
|
export type OpenEditorRequest = { editor_type: string | null, file_path: string | null, };
|
|
|
|
export type OpenEditorResponse = { url: string | null, };
|
|
|
|
export type AssignSharedTaskRequest = { new_assignee_user_id: string | null, };
|
|
|
|
export type ShareTaskResponse = { shared_task_id: string, };
|
|
|
|
export type CreateAndStartTaskRequest = { task: CreateTask, executor_profile_id: ExecutorProfileId, base_branch: string, };
|
|
|
|
export type CreateGitHubPrRequest = { title: string, body: string | null, target_branch: string | null, draft: boolean | null, auto_generate_description: boolean, };
|
|
|
|
export type ImageResponse = { id: string, file_path: string, original_name: string, mime_type: string | null, size_bytes: bigint, hash: string, created_at: string, updated_at: string, };
|
|
|
|
export type ImageMetadata = { exists: boolean, file_name: string | null, path: string | null, size_bytes: bigint | null, format: string | null, proxy_url: string | null, };
|
|
|
|
export type CreateTaskAttemptBody = { task_id: string,
|
|
/**
|
|
* Executor profile specification
|
|
*/
|
|
executor_profile_id: ExecutorProfileId, base_branch: string, };
|
|
|
|
export type RunAgentSetupRequest = { executor_profile_id: ExecutorProfileId, };
|
|
|
|
export type RunAgentSetupResponse = Record<string, never>;
|
|
|
|
export type GhCliSetupError = "BREW_MISSING" | "SETUP_HELPER_NOT_SUPPORTED" | { "OTHER": { message: string, } };
|
|
|
|
export type RebaseTaskAttemptRequest = { old_base_branch: string | null, new_base_branch: string | null, };
|
|
|
|
export type GitOperationError = { "type": "merge_conflicts", message: string, op: ConflictOp, } | { "type": "rebase_in_progress" };
|
|
|
|
export type PushError = { "type": "force_push_required" };
|
|
|
|
export type CreatePrError = { "type": "github_cli_not_installed" } | { "type": "github_cli_not_logged_in" } | { "type": "git_cli_not_logged_in" } | { "type": "git_cli_not_installed" } | { "type": "target_branch_not_found", branch: string, };
|
|
|
|
export type BranchStatus = { commits_behind: number | null, commits_ahead: number | null, has_uncommitted_changes: boolean | null, head_oid: string | null, uncommitted_count: number | null, untracked_count: number | null, target_branch_name: string, remote_commits_behind: number | null, remote_commits_ahead: number | null, merges: Array<Merge>,
|
|
/**
|
|
* True if a `git rebase` is currently in progress in this worktree
|
|
*/
|
|
is_rebase_in_progress: boolean,
|
|
/**
|
|
* Current conflict operation if any
|
|
*/
|
|
conflict_op: ConflictOp | null,
|
|
/**
|
|
* List of files currently in conflicted (unmerged) state
|
|
*/
|
|
conflicted_files: Array<string>, };
|
|
|
|
export type RunScriptError = { "type": "no_script_configured" } | { "type": "process_already_running" };
|
|
|
|
export type AttachPrResponse = { pr_attached: boolean, pr_url: string | null, pr_number: bigint | null, pr_status: MergeStatus | null, };
|
|
|
|
export type PrCommentsResponse = { comments: Array<UnifiedPrComment>, };
|
|
|
|
export type GetPrCommentsError = { "type": "no_pr_attached" } | { "type": "github_cli_not_installed" } | { "type": "github_cli_not_logged_in" };
|
|
|
|
export type UnifiedPrComment = { "comment_type": "general", id: string, author: string, author_association: string, body: string, created_at: string, url: string, } | { "comment_type": "review", id: bigint, author: string, author_association: string, body: string, created_at: string, url: string, path: string, line: bigint | null, diff_hunk: string, };
|
|
|
|
export type DirectoryEntry = { name: string, path: string, is_directory: boolean, is_git_repo: boolean, last_modified: bigint | null, };
|
|
|
|
export type DirectoryListResponse = { entries: Array<DirectoryEntry>, current_path: string, };
|
|
|
|
export type Config = { config_version: string, theme: ThemeMode, executor_profile: ExecutorProfileId, disclaimer_acknowledged: boolean, onboarding_acknowledged: boolean, notifications: NotificationConfig, editor: EditorConfig, github: GitHubConfig, analytics_enabled: boolean, workspace_dir: string | null, last_app_version: string | null, show_release_notes: boolean, language: UiLanguage, git_branch_prefix: string, showcases: ShowcaseState, pr_auto_description_enabled: boolean, pr_auto_description_prompt: string | null, };
|
|
|
|
export type NotificationConfig = { sound_enabled: boolean, push_enabled: boolean, sound_file: SoundFile, };
|
|
|
|
export enum ThemeMode { LIGHT = "LIGHT", DARK = "DARK", SYSTEM = "SYSTEM" }
|
|
|
|
export type EditorConfig = { editor_type: EditorType, custom_command: string | null, remote_ssh_host: string | null, remote_ssh_user: string | null, };
|
|
|
|
export enum EditorType { VS_CODE = "VS_CODE", CURSOR = "CURSOR", WINDSURF = "WINDSURF", INTELLI_J = "INTELLI_J", ZED = "ZED", XCODE = "XCODE", CUSTOM = "CUSTOM" }
|
|
|
|
export type EditorOpenError = { "type": "executable_not_found", executable: string, editor_type: EditorType, } | { "type": "invalid_command", details: string, editor_type: EditorType, } | { "type": "launch_failed", executable: string, details: string, editor_type: EditorType, };
|
|
|
|
export type GitHubConfig = { pat: string | null, oauth_token: string | null, username: string | null, primary_email: string | null, default_pr_base: string | null, };
|
|
|
|
export enum SoundFile { ABSTRACT_SOUND1 = "ABSTRACT_SOUND1", ABSTRACT_SOUND2 = "ABSTRACT_SOUND2", ABSTRACT_SOUND3 = "ABSTRACT_SOUND3", ABSTRACT_SOUND4 = "ABSTRACT_SOUND4", COW_MOOING = "COW_MOOING", PHONE_VIBRATION = "PHONE_VIBRATION", ROOSTER = "ROOSTER" }
|
|
|
|
export type UiLanguage = "BROWSER" | "EN" | "JA" | "ES" | "KO" | "ZH_HANS";
|
|
|
|
export type ShowcaseState = { seen_features: Array<string>, };
|
|
|
|
export type GitBranch = { name: string, is_current: boolean, is_remote: boolean, last_commit_date: Date, };
|
|
|
|
export type SharedTaskDetails = { id: string, project_id: string, title: string, description: string | null, status: TaskStatus, };
|
|
|
|
export type QueuedMessage = {
|
|
/**
|
|
* The task attempt this message is queued for
|
|
*/
|
|
task_attempt_id: string,
|
|
/**
|
|
* The follow-up data (message + variant)
|
|
*/
|
|
data: DraftFollowUpData,
|
|
/**
|
|
* Timestamp when the message was queued
|
|
*/
|
|
queued_at: string, };
|
|
|
|
export type QueueStatus = { "status": "empty" } | { "status": "queued", message: QueuedMessage, };
|
|
|
|
export type ConflictOp = "rebase" | "merge" | "cherry_pick" | "revert";
|
|
|
|
export type ExecutorAction = { typ: ExecutorActionType, next_action: ExecutorAction | null, };
|
|
|
|
export type McpConfig = { servers: { [key in string]?: JsonValue }, servers_path: Array<string>, template: JsonValue, preconfigured: JsonValue, is_toml_config: boolean, };
|
|
|
|
export type ExecutorActionType = { "type": "CodingAgentInitialRequest" } & CodingAgentInitialRequest | { "type": "CodingAgentFollowUpRequest" } & CodingAgentFollowUpRequest | { "type": "ScriptRequest" } & ScriptRequest;
|
|
|
|
export type ScriptContext = "SetupScript" | "CleanupScript" | "DevServer" | "ToolInstallScript";
|
|
|
|
export type ScriptRequest = { script: string, language: ScriptRequestLanguage, context: ScriptContext, };
|
|
|
|
export type ScriptRequestLanguage = "Bash";
|
|
|
|
export enum BaseCodingAgent { CLAUDE_CODE = "CLAUDE_CODE", AMP = "AMP", GEMINI = "GEMINI", CODEX = "CODEX", OPENCODE = "OPENCODE", CURSOR_AGENT = "CURSOR_AGENT", QWEN_CODE = "QWEN_CODE", COPILOT = "COPILOT", DROID = "DROID" }
|
|
|
|
export type CodingAgent = { "CLAUDE_CODE": ClaudeCode } | { "AMP": Amp } | { "GEMINI": Gemini } | { "CODEX": Codex } | { "OPENCODE": Opencode } | { "CURSOR_AGENT": CursorAgent } | { "QWEN_CODE": QwenCode } | { "COPILOT": Copilot } | { "DROID": Droid };
|
|
|
|
export type AvailabilityInfo = { "type": "LOGIN_DETECTED", last_auth_timestamp: bigint, } | { "type": "INSTALLATION_FOUND" } | { "type": "NOT_FOUND" };
|
|
|
|
export type CommandBuilder = {
|
|
/**
|
|
* Base executable command (e.g., "npx -y @anthropic-ai/claude-code@latest")
|
|
*/
|
|
base: string,
|
|
/**
|
|
* Optional parameters to append to the base command
|
|
*/
|
|
params: Array<string> | null, };
|
|
|
|
export type ExecutorProfileId = {
|
|
/**
|
|
* The executor type (e.g., "CLAUDE_CODE", "AMP")
|
|
*/
|
|
executor: BaseCodingAgent,
|
|
/**
|
|
* Optional variant name (e.g., "PLAN", "ROUTER")
|
|
*/
|
|
variant: string | null, };
|
|
|
|
export type ExecutorConfig = { [key in string]?: { "CLAUDE_CODE": ClaudeCode } | { "AMP": Amp } | { "GEMINI": Gemini } | { "CODEX": Codex } | { "OPENCODE": Opencode } | { "CURSOR_AGENT": CursorAgent } | { "QWEN_CODE": QwenCode } | { "COPILOT": Copilot } | { "DROID": Droid } };
|
|
|
|
export type ExecutorConfigs = { executors: { [key in BaseCodingAgent]?: ExecutorConfig }, };
|
|
|
|
export enum BaseAgentCapability { SESSION_FORK = "SESSION_FORK", SETUP_HELPER = "SETUP_HELPER" }
|
|
|
|
export type ClaudeCode = { append_prompt: AppendPrompt, claude_code_router?: boolean | null, plan?: boolean | null, approvals?: boolean | null, model?: string | null, dangerously_skip_permissions?: boolean | null, disable_api_key?: boolean | null, base_command_override?: string | null, additional_params?: Array<string> | null, env?: { [key in string]?: string } | null, };
|
|
|
|
export type Gemini = { append_prompt: AppendPrompt, model?: string | null, yolo?: boolean | null, base_command_override?: string | null, additional_params?: Array<string> | null, env?: { [key in string]?: string } | null, };
|
|
|
|
export type Amp = { append_prompt: AppendPrompt, dangerously_allow_all?: boolean | null, base_command_override?: string | null, additional_params?: Array<string> | null, env?: { [key in string]?: string } | null, };
|
|
|
|
export type Codex = { append_prompt: AppendPrompt, sandbox?: SandboxMode | null, ask_for_approval?: AskForApproval | null, oss?: boolean | null, model?: string | null, model_reasoning_effort?: ReasoningEffort | null, model_reasoning_summary?: ReasoningSummary | null, model_reasoning_summary_format?: ReasoningSummaryFormat | null, profile?: string | null, base_instructions?: string | null, include_apply_patch_tool?: boolean | null, model_provider?: string | null, compact_prompt?: string | null, developer_instructions?: string | null, base_command_override?: string | null, additional_params?: Array<string> | null, env?: { [key in string]?: string } | null, };
|
|
|
|
export type SandboxMode = "auto" | "read-only" | "workspace-write" | "danger-full-access";
|
|
|
|
export type AskForApproval = "unless-trusted" | "on-failure" | "on-request" | "never";
|
|
|
|
export type ReasoningEffort = "low" | "medium" | "high" | "xhigh";
|
|
|
|
export type ReasoningSummary = "auto" | "concise" | "detailed" | "none";
|
|
|
|
export type ReasoningSummaryFormat = "none" | "experimental";
|
|
|
|
export type CursorAgent = { append_prompt: AppendPrompt, force?: boolean | null, model?: string | null, base_command_override?: string | null, additional_params?: Array<string> | null, env?: { [key in string]?: string } | null, };
|
|
|
|
export type Copilot = { append_prompt: AppendPrompt, model?: string | null, allow_all_tools?: boolean | null, allow_tool?: string | null, deny_tool?: string | null, add_dir?: Array<string> | null, disable_mcp_server?: Array<string> | null, base_command_override?: string | null, additional_params?: Array<string> | null, env?: { [key in string]?: string } | null, };
|
|
|
|
export type Opencode = { append_prompt: AppendPrompt, model?: string | null, mode?: string | null, base_command_override?: string | null, additional_params?: Array<string> | null, env?: { [key in string]?: string } | null, };
|
|
|
|
export type QwenCode = { append_prompt: AppendPrompt, yolo?: boolean | null, base_command_override?: string | null, additional_params?: Array<string> | null, env?: { [key in string]?: string } | null, };
|
|
|
|
export type Droid = { append_prompt: AppendPrompt, autonomy: Autonomy, model?: string | null, reasoning_effort?: DroidReasoningEffort | null, base_command_override?: string | null, additional_params?: Array<string> | null, env?: { [key in string]?: string } | null, };
|
|
|
|
export type Autonomy = "normal" | "low" | "medium" | "high" | "skip-permissions-unsafe";
|
|
|
|
export type DroidReasoningEffort = "none" | "dynamic" | "off" | "low" | "medium" | "high";
|
|
|
|
export type AppendPrompt = string | null;
|
|
|
|
export type CodingAgentInitialRequest = { prompt: string,
|
|
/**
|
|
* Executor profile specification
|
|
*/
|
|
executor_profile_id: ExecutorProfileId, };
|
|
|
|
export type CodingAgentFollowUpRequest = { prompt: string, session_id: string,
|
|
/**
|
|
* Executor profile specification
|
|
*/
|
|
executor_profile_id: ExecutorProfileId, };
|
|
|
|
export type CommandExitStatus = { "type": "exit_code", code: number, } | { "type": "success", success: boolean, };
|
|
|
|
export type CommandRunResult = { exit_status: CommandExitStatus | null, output: string | null, };
|
|
|
|
export type NormalizedEntry = { timestamp: string | null, entry_type: NormalizedEntryType, content: string, };
|
|
|
|
export type NormalizedEntryType = { "type": "user_message" } | { "type": "user_feedback", denied_tool: string, } | { "type": "assistant_message" } | { "type": "tool_use", tool_name: string, action_type: ActionType, status: ToolStatus, } | { "type": "system_message" } | { "type": "error_message", error_type: NormalizedEntryError, } | { "type": "thinking" } | { "type": "loading" } | { "type": "next_action", failed: boolean, execution_processes: number, needs_setup: boolean, };
|
|
|
|
export type FileChange = { "action": "write", content: string, } | { "action": "delete" } | { "action": "rename", new_path: string, } | { "action": "edit",
|
|
/**
|
|
* Unified diff containing file header and hunks.
|
|
*/
|
|
unified_diff: string,
|
|
/**
|
|
* Whether line number in the hunks are reliable.
|
|
*/
|
|
has_line_numbers: boolean, };
|
|
|
|
export type ActionType = { "action": "file_read", path: string, } | { "action": "file_edit", path: string, changes: Array<FileChange>, } | { "action": "command_run", command: string, result: CommandRunResult | null, } | { "action": "search", query: string, } | { "action": "web_fetch", url: string, } | { "action": "tool", tool_name: string, arguments: JsonValue | null, result: ToolResult | null, } | { "action": "task_create", description: string, } | { "action": "plan_presentation", plan: string, } | { "action": "todo_management", todos: Array<TodoItem>, operation: string, } | { "action": "other", description: string, };
|
|
|
|
export type TodoItem = { content: string, status: string, priority: string | null, };
|
|
|
|
export type NormalizedEntryError = { "type": "setup_required" } | { "type": "other" };
|
|
|
|
export type ToolResult = { type: ToolResultValueType,
|
|
/**
|
|
* For Markdown, this will be a JSON string; for JSON, a structured value
|
|
*/
|
|
value: JsonValue, };
|
|
|
|
export type ToolResultValueType = { "type": "markdown" } | { "type": "json" };
|
|
|
|
export type ToolStatus = { "status": "created" } | { "status": "success" } | { "status": "failed" } | { "status": "denied", reason: string | null, } | { "status": "pending_approval", approval_id: string, requested_at: string, timeout_at: string, } | { "status": "timed_out" };
|
|
|
|
export type PatchType = { "type": "NORMALIZED_ENTRY", "content": NormalizedEntry } | { "type": "STDOUT", "content": string } | { "type": "STDERR", "content": string } | { "type": "DIFF", "content": Diff };
|
|
|
|
export type JsonValue = number | string | boolean | Array<JsonValue> | { [key in string]?: JsonValue } | null;
|
|
|
|
export const DEFAULT_PR_DESCRIPTION_PROMPT = `Update the GitHub PR that was just created with a better title and description.
|
|
The PR number is #{pr_number} and the URL is {pr_url}.
|
|
|
|
Analyze the changes in this branch and write:
|
|
1. A concise, descriptive title that summarizes the changes, postfixed with "(Vibe Kanban)"
|
|
2. A detailed description that explains:
|
|
- What changes were made
|
|
- Why they were made (based on the task context)
|
|
- Any important implementation details
|
|
- At the end, include a note: "This PR was written using [Vibe Kanban](https://vibekanban.com)"
|
|
|
|
Use \`gh pr edit\` to update the PR.`; |