This repository was archived by the owner on Aug 27, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 57
Workflow docs #58
Merged
Merged
Workflow docs #58
Changes from all commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
e432f72
Copy workflow docs from Cline
chrarnoldus b566b72
Fix crash
chrarnoldus 7a4c41a
Replace mentions of Cline with Kilo Code
chrarnoldus df1a0c3
Replace with Kilo Code screenshot
chrarnoldus 00fdfad
Add some kilo specific info
chrarnoldus 67aba16
Remove link that doesn't exist
chrarnoldus 47b457f
Delete Cline's real-world example
chrarnoldus 22cb4e9
Less convoluted real world example
chrarnoldus 889833f
I think this needs to be here
chrarnoldus 75cf776
Creating a pr from main doesn't make sense
chrarnoldus 7c110ba
Reorder
chrarnoldus 8086a83
Improvements by Kilo Code
chrarnoldus e428780
Remove stuff I don't feel like testing
chrarnoldus File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| --- | ||
| title: "Workflows" | ||
| sidebarTitle: "Workflows" | ||
| --- | ||
|
|
||
| Workflows automate repetitive tasks by defining step-by-step instructions for Kilo Code to execute. Invoke any workflow by typing `/[workflow-name.md]` in the chat. | ||
|
|
||
| <img src="/docs/img/slash-commands/workflows.png" alt="Workflows tab in Kilo Code" width="600" /> | ||
|
|
||
| ## Creating Workflows | ||
|
|
||
| Workflows are markdown files stored in `.kilocode/workflows/`: | ||
| - **Global workflows**: `~/.kilocode/workflows/` (available in all projects) | ||
| - **Project workflows**: `[project]/.kilocode/workflows/` (project-specific) | ||
|
|
||
| ### Basic Setup | ||
|
|
||
| 1. Create a `.md` file with step-by-step instructions | ||
| 2. Save it in your workflows directory | ||
| 3. Type `/filename.md` to execute | ||
|
|
||
| ### Workflow Capabilities | ||
|
|
||
| Workflows can leverage: | ||
| - [Built-in tools](/features/tools/tool-use-overview): [`read_file()`](/features/tools/read-file), [`search_files()`](/features/tools/search-files), [`execute_command()`](/features/tools/execute-command) | ||
| - CLI tools: `gh`, `docker`, `npm`, custom scripts | ||
| - [MCP integrations](/features/mcp/overview): Slack, databases, APIs | ||
| - [Mode switching](/basic-usage/using-modes): [`new_task()`](/features/tools/new-task) for specialized contexts | ||
|
|
||
| ## Common Workflow Patterns | ||
|
|
||
| **Release Management** | ||
| ```markdown | ||
| 1. Gather merged PRs since last release | ||
| 2. Generate changelog from commit messages | ||
| 3. Update version numbers | ||
| 4. Create release branch and tag | ||
| 5. Deploy to staging environment | ||
| ``` | ||
|
|
||
| **Project Setup** | ||
| ```markdown | ||
| 1. Clone repository template | ||
| 2. Install dependencies (`npm install`, `pip install -r requirements.txt`) | ||
| 3. Configure environment files | ||
| 4. Initialize database/services | ||
| 5. Run initial tests | ||
| ``` | ||
|
|
||
| **Code Review Preparation** | ||
| ```markdown | ||
| 1. Search for TODO comments and debug statements | ||
| 2. Run linting and formatting | ||
| 3. Execute test suite | ||
| 4. Generate PR description from recent commits | ||
| ``` | ||
|
|
||
| ## Example: PR Submission Workflow | ||
|
|
||
| Let's walk through creating a workflow for submitting a pull request. This workflow handles the entire process from code review to deployment notification. | ||
|
|
||
| Create a file called `submit-pr.md` in your `.kilocode/workflows` directory: | ||
|
|
||
| ```markdown | ||
| # Submit PR Workflow | ||
|
|
||
| You are helping submit a pull request. Follow these steps: | ||
|
|
||
| 1. First, use `search_files` to check for any TODO comments or console.log statements that shouldn't be committed | ||
| 2. Run tests using `execute_command` with `npm test` or the appropriate test command | ||
| 3. If tests pass, stage and commit changes with a descriptive commit message | ||
| 4. Push the branch and create a pull request using `gh pr create` | ||
| 5. Use `ask_followup_question` to get the PR title and description from the user | ||
|
|
||
| Parameters needed (ask if not provided): | ||
| - Branch name | ||
| - Reviewers to assign | ||
| ``` | ||
|
|
||
| Now you can trigger this workflow by typing `/submit-pr.md` in the chat. Kilo Code will: | ||
|
|
||
| - Scan your code for common issues before committing | ||
| - Run your test suite to catch problems early | ||
| - Handle the Git operations and PR creation | ||
| - Notify your team automatically | ||
| - Set up follow-up tasks for deployment | ||
|
|
||
| This saves you from manually running the same 7-step process every time you want to submit code for review. | ||
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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.
Uh oh!
There was an error while loading. Please reload this page.