summaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorEd Zynda <[email protected]>2025-05-15 16:52:24 +0300
committeradamdottv <[email protected]>2025-05-15 09:43:33 -0500
commitab150be7c393a91d9fb2347b7012ad2f7d77700b (patch)
treef83cc39853f73d62227121af27739d1c310e02e6 /README.md
parenta203fb8cccf45d74fb217bdc579155ee058af248 (diff)
downloadopencode-ab150be7c393a91d9fb2347b7012ad2f7d77700b.tar.gz
opencode-ab150be7c393a91d9fb2347b7012ad2f7d77700b.zip
feat: Support named arguments in custom commands (#158)
* Allow multiple named args * fix: Fix styling in multi-arguments dialog * Remove old unused modal * Focus on only one input at a time
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 13 insertions, 3 deletions
diff --git a/README.md b/README.md
index d26d74741..d7ae5e928 100644
--- a/README.md
+++ b/README.md
@@ -21,6 +21,7 @@ OpenCode is a Go-based CLI application that brings AI assistance to your termina
- **LSP Integration**: Language Server Protocol support for code intelligence
- **File Change Tracking**: Track and visualize file changes during sessions
- **External Editor Support**: Open your preferred editor for composing messages
+- **Named Arguments for Custom Commands**: Create powerful custom commands with multiple named placeholders
## Installation
@@ -428,13 +429,22 @@ This creates a command called `user:prime-context`.
### Command Arguments
-You can create commands that accept arguments by including the `$ARGUMENTS` placeholder in your command file:
+OpenCode supports named arguments in custom commands using placeholders in the format `$NAME` (where NAME consists of uppercase letters, numbers, and underscores, and must start with a letter).
+
+For example:
```markdown
-RUN git show $ARGUMENTS
+# Fetch Context for Issue $ISSUE_NUMBER
+
+RUN gh issue view $ISSUE_NUMBER --json title,body,comments
+RUN git grep --author="$AUTHOR_NAME" -n .
+RUN grep -R "$SEARCH_PATTERN" $DIRECTORY
```
-When you run this command, OpenCode will prompt you to enter the text that should replace `$ARGUMENTS`.
+When you run a command with arguments, OpenCode will prompt you to enter values for each unique placeholder. Named arguments provide several benefits:
+- Clear identification of what each argument represents
+- Ability to use the same argument multiple times
+- Better organization for commands with multiple inputs
### Organizing Commands