summaryrefslogtreecommitdiff
path: root/server/continuedev/plugins/recipes/TemplateRecipe
diff options
context:
space:
mode:
Diffstat (limited to 'server/continuedev/plugins/recipes/TemplateRecipe')
-rw-r--r--server/continuedev/plugins/recipes/TemplateRecipe/README.md7
-rw-r--r--server/continuedev/plugins/recipes/TemplateRecipe/main.py29
2 files changed, 36 insertions, 0 deletions
diff --git a/server/continuedev/plugins/recipes/TemplateRecipe/README.md b/server/continuedev/plugins/recipes/TemplateRecipe/README.md
new file mode 100644
index 00000000..91d1123b
--- /dev/null
+++ b/server/continuedev/plugins/recipes/TemplateRecipe/README.md
@@ -0,0 +1,7 @@
+# TemplateRecipe
+
+This folder is a template that you can copy to create your own recipe.
+
+## How to use this recipe
+
+Explain here what users should know when using your recipe. What inputs does it have and what actions will it perform?
diff --git a/server/continuedev/plugins/recipes/TemplateRecipe/main.py b/server/continuedev/plugins/recipes/TemplateRecipe/main.py
new file mode 100644
index 00000000..01ae364d
--- /dev/null
+++ b/server/continuedev/plugins/recipes/TemplateRecipe/main.py
@@ -0,0 +1,29 @@
+from typing import Coroutine
+
+from ....core.main import Observation, Step
+from ....core.sdk import ContinueSDK, Models
+
+
+class TemplateRecipe(Step):
+ """
+ A simple recipe that appends a print statement to the currently open file.
+ Use this as a template to create your own!
+ """
+
+ # Parameters for the recipe
+ name: str
+
+ # A title for the recipe, to be displayed in the GUI
+ title = "Template Recipe"
+
+ # A description of what the recipe accomplished, to be displayed in the GUI
+ async def describe(self, models: Models) -> Coroutine[str, None, None]:
+ return f"Appended a statement to print `Hello, {self.name}!` at the end of the file."
+
+ # The code executed when the recipe is run
+ async def run(self, sdk: ContinueSDK) -> Coroutine[Observation, None, None]:
+ visible_files = await sdk.ide.getVisibleFiles()
+ await sdk.edit_file(
+ filename=visible_files[0],
+ prompt=f"Append a statement to print `Hello, {self.name}!` at the end of the file.",
+ )