README
¶
slashcommand
Package slashcommand provides a parser for slash commands commonly used in AI coding assistants.
Overview
This package parses slash commands using bash-like argument parsing:
/task-name arg1 "arg 2" arg3
The parser extracts:
- Task name: The command identifier (without the leading
/) - Arguments: Positional arguments accessed via
$ARGUMENTS,$1,$2,$3, etc.
Arguments are parsed like bash:
- Quoted arguments (single or double quotes) can contain spaces
- Quotes are removed from parsed arguments
- Escape sequences are supported in double quotes (
\")
Installation
go get github.com/kitproj/coding-context-cli/pkg/slashcommand
Usage
import "github.com/kitproj/coding-context-cli/pkg/slashcommand"
// Parse a simple command
taskName, params, err := slashcommand.ParseSlashCommand("/fix-bug")
// taskName: "fix-bug"
// params: map[]
// Parse a command with arguments
taskName, params, err := slashcommand.ParseSlashCommand("/fix-bug 123")
// taskName: "fix-bug"
// params: map["ARGUMENTS": "123", "1": "123"]
// Parse a command with quoted arguments
taskName, params, err := slashcommand.ParseSlashCommand(`/code-review "Fix login bug" high`)
// taskName: "code-review"
// params: map["ARGUMENTS": "\"Fix login bug\" high", "1": "Fix login bug", "2": "high"]
Command Format
Basic Structure
/task-name arg1 "arg 2" arg3 ...
Argument Parsing Rules
- Commands must start with
/ - Task name comes immediately after the
/(no spaces) - Arguments can be quoted with single (
') or double (") quotes - Quoted arguments can contain spaces
- Quotes are removed from parsed arguments
- Double quotes support escape sequences:
\" - Single quotes preserve everything literally (no escapes)
Returned Parameters
The params map contains:
ARGUMENTS: The full argument string (with quotes preserved)1,2,3, etc.: Individual positional arguments (with quotes removed)
Valid Examples
/fix-bug # No arguments
/fix-bug 123 # Single argument: $1 = "123"
/deploy staging v1.2.3 # Two arguments: $1 = "staging", $2 = "v1.2.3"
/code-review "PR #42" # Quoted argument: $1 = "PR #42"
/echo 'He said "hello"' # Single quotes preserve quotes: $1 = "He said \"hello\""
/echo "He said \"hello\"" # Escaped quotes in double quotes: $1 = "He said \"hello\""
Invalid Examples
fix-bug # Missing leading /
/ # Empty command
/fix-bug "unclosed # Unclosed quote
Error Handling
The parser returns descriptive errors for invalid commands:
_, _, err := slashcommand.ParseSlashCommand("fix-bug")
// Error: slash command must start with '/'
_, _, err := slashcommand.ParseSlashCommand("/")
// Error: slash command cannot be empty
_, _, err := slashcommand.ParseSlashCommand(`/fix-bug "unclosed`)
// Error: unclosed quote in arguments
API
ParseSlashCommand
func ParseSlashCommand(command string) (taskName string, params map[string]string, err error)
Parses a slash command string and extracts the task name and arguments.
Parameters:
command(string): The slash command to parse
Returns:
taskName(string): The task name without the leading/params(map[string]string): ContainsARGUMENTS(full arg string) and1,2,3, etc. (positional args)err(error): Error if the command format is invalid
Testing
The package includes comprehensive tests covering:
- Commands without arguments
- Commands with single and multiple arguments
- Quoted arguments (both single and double quotes)
- Escaped quotes
- Empty quoted arguments
- Edge cases and error conditions
Run tests with:
go test -v ./pkg/slashcommand
License
This package is part of the coding-context-cli project and is licensed under the MIT License.
Documentation
¶
Index ¶
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ParseSlashCommand ¶
ParseSlashCommand parses a slash command string and extracts the task name and parameters. The expected format is: /task-name arg1 "arg 2" arg3
Arguments are parsed like Bash:
- Quoted arguments can contain spaces
- Both single and double quotes are supported
- Quotes are removed from the parsed arguments
Examples:
- "/fix-bug 123" -> taskName: "fix-bug", params: {"ARGUMENTS": "123", "1": "123"}
- "/code-review \"PR #42\" high" -> taskName: "code-review", params: {"ARGUMENTS": "\"PR #42\" high", "1": "PR #42", "2": "high"}
Returns:
- taskName: the task name (without the leading slash)
- params: a map containing:
- "ARGUMENTS": the full argument string (with quotes preserved)
- "1", "2", "3", etc.: positional arguments (with quotes removed)
- err: an error if the command format is invalid
Example ¶
package main
import (
"fmt"
"github.com/kitproj/coding-context-cli/pkg/slashcommand"
)
func main() {
// Parse a simple command without parameters
taskName, params, err := slashcommand.ParseSlashCommand("/fix-bug")
if err != nil {
fmt.Printf("Error: %v\n", err)
return
}
fmt.Printf("Task: %s, Params: %v\n", taskName, params)
// Parse a command with single argument
taskName, params, err = slashcommand.ParseSlashCommand("/fix-bug 123")
if err != nil {
fmt.Printf("Error: %v\n", err)
return
}
fmt.Printf("Task: %s, $1: %s\n", taskName, params["1"])
// Parse a command with multiple arguments
taskName, params, err = slashcommand.ParseSlashCommand(`/implement-feature "User Login" high`)
if err != nil {
fmt.Printf("Error: %v\n", err)
return
}
fmt.Printf("Task: %s, $1: %s, $2: %s\n", taskName, params["1"], params["2"])
}
Output: Task: fix-bug, Params: map[] Task: fix-bug, $1: 123 Task: implement-feature, $1: User Login, $2: high
Types ¶
This section is empty.
Source Files
Click to show internal directories.
Click to hide internal directories.