summaryrefslogtreecommitdiff
path: root/packages/examples/background_agent/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'packages/examples/background_agent/README.md')
-rw-r--r--packages/examples/background_agent/README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/packages/examples/background_agent/README.md b/packages/examples/background_agent/README.md
new file mode 100644
index 00000000..0e5fd6dc
--- /dev/null
+++ b/packages/examples/background_agent/README.md
@@ -0,0 +1,16 @@
+# Demo Background Agent
+
+A pretend background agent that does not actually process tasks in the background. Configure in your settings.json with:
+
+```javascript
+ "backgroundAgents": {
+ "demo-background-agent": {
+ "command": "npm",
+ "args": [
+ "run",
+ "start:demo-background-agent",
+ "--workspace=@google/gemini-cli-examples"
+ ]
+ }
+ },
+```