Skip to content

Add bootcommand mappings for left/right command and option keys #218

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
edigaryev merged 1 commit into from
Jan 28, 2026
Merged

Add bootcommand mappings for left/right command and option keys #218

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .web-docs/components/builder/tart/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -272,8 +272,10 @@ For more examples of various boot commands, see the sample projects from our
<!-- End of code generated from the comments of the BootConfig struct in bootcommand/config.go; -->


Additionally, Tart builder supports the following custom commands that utilize computer vision:
Additionally, Tart builder supports the following custom commands:

* `<leftCommand> <rightCommand>` - Simulates pressing the ⌘ key.
* `<leftOption> <rightOption>` - Simulates pressing the ⌥ key.
* `<wait 'string'>` — waits for the given string to appear in the VM's screen output
* the `string` can be a simple word, a sentence or a regular expression
* alternative to `<waitXX>` command with large values
Expand Down
14 changes: 14 additions & 0 deletions builder/tart/step_run.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,6 +266,20 @@ func typeBootCommandOverVNC(
command = stringClickRegex.ReplaceAllString(command,
fmt.Sprintf(`%c${1}%c`, ClickStringStart, ClickStringEnd))

// Waiting for https://github.com/hashicorp/packer-plugin-sdk/pull/293
leftCommandRegex := regexp.MustCompile(`<leftCommand(On|Off)?>`)
command = leftCommandRegex.ReplaceAllString(command,
fmt.Sprintf(`<%c${1}>`, LeftCommand))
rightCommandRegex := regexp.MustCompile(`<rightCommand(On|Off)?>`)
command = rightCommandRegex.ReplaceAllString(command,
fmt.Sprintf(`<%c${1}>`, RightCommand))
leftOptionRegex := regexp.MustCompile(`<leftOption(On|Off)?>`)
command = leftOptionRegex.ReplaceAllString(command,
fmt.Sprintf(`<%c${1}>`, LeftOption))
rightOptionRegex := regexp.MustCompile(`<rightOption(On|Off)?>`)
command = rightOptionRegex.ReplaceAllString(command,
fmt.Sprintf(`<%c${1}>`, RightOption))

seq, err := bootcommand.GenerateExpressionSequence(command)
if err != nil {
err := fmt.Errorf("Failed to parse the boot command: %s", err)
Expand Down
5 changes: 5 additions & 0 deletions builder/tart/vnc.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,11 @@ const (

ClickStringStart rune = 0xE0002
ClickStringEnd rune = 0xE0003

LeftCommand rune = 0xFFE9
RightCommand rune = 0xFFEA
LeftOption rune = 0xFFE7
RightOption rune = 0xFFE8
)

func (d *customDriver) SendKey(key rune, action bootcommand.KeyAction) error {
Expand Down
4 changes: 3 additions & 1 deletion docs/builders/tart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,8 +90,10 @@ For more advanced examples, please refer to the [`example/` directory](https://g

@include 'packer-plugin-sdk/bootcommand/BootConfig.mdx'

Additionally, Tart builder supports the following custom commands that utilize computer vision:
Additionally, Tart builder supports the following custom commands:

* `<leftCommand> <rightCommand>` - Simulates pressing the ⌘ key.
* `<leftOption> <rightOption>` - Simulates pressing the ⌥ key.
* `<wait 'string'>` — waits for the given string to appear in the VM's screen output
* the `string` can be a simple word, a sentence or a regular expression
* alternative to `<waitXX>` command with large values
Expand Down