Add: _example, Update: README.md
This commit is contained in:
parent
9dbc5b7ef7
commit
ee5b4a43f1
118
README.md
118
README.md
@ -2,41 +2,114 @@
|
||||
[](https://godoc.org/git.tcp.direct/kayos/sendkeys)
|
||||
[](https://goreportcard.com/report/github.com/yunginnanet/sendkeys)
|
||||
|
||||
### sendkeys is a cross-platform usability wrapper for the [keybd_event](https://github.com/micmonay/keybd_event) Go library.
|
||||
## Summary
|
||||
|
||||
---
|
||||
sendkeys is a cross-platform usability wrapper for the [keybd_event](https://github.com/micmonay/keybd_event) Go library.
|
||||
|
||||
Use this library to turn full strings into simulated keyboard events with ease. This library was created after a noVNC instance I was using had a broken clipboard feature.
|
||||
|
||||
### Summary
|
||||
Use this library to turn full strings into simulated keyboard events with ease;
|
||||
along with some neat features like **optionally randomized delays**.
|
||||
I have successfully used the [example](./_example/main.go) to send a very long password into a NoVNC instance that had all kinds of varying case alphanumeric characters along with many symbols.
|
||||
|
||||
---
|
||||
## Features
|
||||
|
||||
### Improvements
|
||||
* Optimized map lookups
|
||||
* Optionally randomized delays between keypresses.
|
||||
|
||||
* Negative integer -> abs inversion to determine shift key necessity
|
||||
* Optimized map lookups should provide very high performance.
|
||||
|
||||
* Negative integer -> abs inversion to determine when to send the shift key event.
|
||||
|
||||
* Only send one key at a time, and clear the state inbetween keys for reliable functionality.
|
||||
|
||||
* Only send one key at a time, clear state in between
|
||||
* Appears to provide a *faster*, *more reliable*, and *easier to use* way for humans to access to the functionality of [keybd_event](https://github.com/micmonay/keybd_event).
|
||||
|
||||
This appears to provide a *faster*, *more reliable*, and *easier to use* interface to the functionality of [keybd_event](https://github.com/micmonay/keybd_event).
|
||||
## Documentation
|
||||
|
||||
#### For simple usage, take a look at [the example](./_example/main.go).
|
||||
|
||||
<details>
|
||||
<summary>GoDoc</summary>
|
||||
|
||||
#### See [my test results](#test) below and compare this wrapper with [keybd_event](https://github.com/micmonay/keybd_event) alone.
|
||||
#### type KBOpt
|
||||
|
||||
---
|
||||
```go
|
||||
type KBOpt uint8
|
||||
```
|
||||
|
||||
|
||||
KBOpt[s] are options for our wrapper
|
||||
|
||||
### Usage
|
||||
```go
|
||||
const (
|
||||
// Stubborn will cause our sequences to continue despite errors.
|
||||
// Otherwise, we will stop if our error count is over 0.
|
||||
Stubborn KBOpt = iota
|
||||
// Noisy will cause all errors to be printed to stdout.
|
||||
Noisy
|
||||
// Random will use random sleeps throughout the typing process.
|
||||
// Otherwise, a static 10 milliseconds will be used.
|
||||
Random
|
||||
// NoDelay will bypass the 2 second delay for linux, mostly for testing.
|
||||
NoDelay
|
||||
)
|
||||
```
|
||||
|
||||
#### Check the [unit test](./sendkeys_test.go) and the [docs](https://godoc.org/git.tcp.direct/kayos/sendkeys).
|
||||
#### type KBWrap
|
||||
|
||||
### Status
|
||||
```go
|
||||
type KBWrap struct {
|
||||
// There are unexported fields
|
||||
}
|
||||
```
|
||||
|
||||
KBWrap is a wrapper for the keybd_event library for convenience
|
||||
|
||||
#### func NewKBWrapWithOptions
|
||||
|
||||
```go
|
||||
func NewKBWrapWithOptions(opts ...KBOpt) (kbw *KBWrap, err error)
|
||||
```
|
||||
NewKBWrapWithOptions creates a new keyboard wrapper with the given options. As
|
||||
of writing, those options include: Stubborn Noisy and Random. The defaults are
|
||||
all false.
|
||||
|
||||
#### func (*KBWrap) BackSpace
|
||||
|
||||
```go
|
||||
func (kb *KBWrap) BackSpace()
|
||||
```
|
||||
BackSpace presses the backspace key. All other keys will be cleared.
|
||||
|
||||
#### func (*KBWrap) Enter
|
||||
|
||||
```go
|
||||
func (kb *KBWrap) Enter()
|
||||
```
|
||||
Enter presses the enter key. All other keys will be cleared.
|
||||
|
||||
#### func (*KBWrap) Escape
|
||||
|
||||
```go
|
||||
func (kb *KBWrap) Escape()
|
||||
```
|
||||
Escape presses the escape key. All other keys will be cleared.
|
||||
|
||||
#### func (*KBWrap) Tab
|
||||
|
||||
```go
|
||||
func (kb *KBWrap) Tab()
|
||||
```
|
||||
Tab presses the tab key. All other keys will be cleared.
|
||||
|
||||
#### func (*KBWrap) Type
|
||||
|
||||
```go
|
||||
func (kb *KBWrap) Type(s string) error
|
||||
```
|
||||
Type types out a string by simulating keystrokes. Check the exported Symbol map
|
||||
for non-alphanumeric keys.
|
||||
|
||||
</details>
|
||||
|
||||
## Status
|
||||
|
||||
sendkeys is in early development. tests pass on a real machine, but I'm done trying to make github actions work for this one.
|
||||
|
||||
@ -183,10 +256,15 @@ ok git.tcp.direct/kayos/sendkeys 8.139s
|
||||
|
||||
</details>
|
||||
|
||||
### Compatibility
|
||||
## Compatibility
|
||||
|
||||
sendkeys has only been tested in Linux so far, however the underlying library seemingly has support for all Go platforms. This should be cross platform.
|
||||
~~sendkeys has only been tested in Linux so far~~
|
||||
|
||||
the underlying library seemingly has support for all Go platforms. This should be cross platform.
|
||||
|
||||
Recently briefly tested in windows, I'm not sure that the shift key trigger is working or not. Needs to be tested further.
|
||||
|
||||
## Credits
|
||||
|
||||
### Credits
|
||||
* ##### [micmonay](https://github.com/micmonay) of course, for creating [keybd_event](https://github.com/micmonay/keybd_event).
|
||||
* ##### [Christopher Latham Sholes](https://en.wikipedia.org/wiki/Christopher_Latham_Sholes) for his work on the QWERTY keyboard.
|
||||
|
||||
7
_example/go.mod
Normal file
7
_example/go.mod
Normal file
@ -0,0 +1,7 @@
|
||||
module chatsend
|
||||
|
||||
go 1.17
|
||||
|
||||
require git.tcp.direct/kayos/sendkeys v0.0.0-20211205165836-9dbc5b7ef7f8
|
||||
|
||||
require github.com/micmonay/keybd_event v1.1.1 // indirect
|
||||
8
_example/go.sum
Normal file
8
_example/go.sum
Normal file
@ -0,0 +1,8 @@
|
||||
git.tcp.direct/kayos/sendkeys v0.0.0-20211205165836-9dbc5b7ef7f8 h1:MLok7dkRnVSNxOi14WF8z9m5tydrCn5wVTCV/ThQ9cs=
|
||||
git.tcp.direct/kayos/sendkeys v0.0.0-20211205165836-9dbc5b7ef7f8/go.mod h1:edjLKQfay4hUSVqDbZ7JoYg1PwM2BbUQ+rcoh9pz9qQ=
|
||||
github.com/eiannone/keyboard v0.0.0-20200508000154-caf4b762e807 h1:jdjd5e68T4R/j4PWxfZqcKY8KtT9oo8IPNVuV4bSXDQ=
|
||||
github.com/eiannone/keyboard v0.0.0-20200508000154-caf4b762e807/go.mod h1:Xoiu5VdKMvbRgHuY7+z64lhu/7lvax/22nzASF6GrO8=
|
||||
github.com/micmonay/keybd_event v1.1.1 h1:rv7omwXWYL9Lgf3PUq6uBgJI2k1yGkL/GD6dxc6nmSs=
|
||||
github.com/micmonay/keybd_event v1.1.1/go.mod h1:CGMWMDNgsfPljzrAWoybUOSKafQPZpv+rLigt2LzNGI=
|
||||
golang.org/x/sys v0.0.0-20211124211545-fe61309f8881 h1:TyHqChC80pFkXWraUUf6RuB5IqFdQieMLwwCJokV2pc=
|
||||
golang.org/x/sys v0.0.0-20211124211545-fe61309f8881/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||
76
_example/main.go
Normal file
76
_example/main.go
Normal file
@ -0,0 +1,76 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"bufio"
|
||||
"fmt"
|
||||
"os"
|
||||
"strconv"
|
||||
"time"
|
||||
|
||||
"git.tcp.direct/kayos/sendkeys"
|
||||
)
|
||||
|
||||
var (
|
||||
sleeptime = 10
|
||||
random = false
|
||||
textlines []string
|
||||
)
|
||||
|
||||
func init() {
|
||||
parseArgs()
|
||||
|
||||
scanner := bufio.NewScanner(os.Stdin)
|
||||
for scanner.Scan() {
|
||||
textlines = append(textlines, scanner.Text())
|
||||
}
|
||||
fmt.Printf("\ngot %d lines from standard input\n", len(textlines))
|
||||
}
|
||||
|
||||
func parseArgs() {
|
||||
for i, arg := range os.Args {
|
||||
if arg == "" {
|
||||
continue
|
||||
}
|
||||
if arg == "-n" && len(os.Args) >= i {
|
||||
sleep, err := strconv.Atoi(os.Args[i+1])
|
||||
if err == nil {
|
||||
sleeptime = sleep
|
||||
os.Args[i+1] = ""
|
||||
}
|
||||
}
|
||||
if arg == "-r" {
|
||||
random = true
|
||||
}
|
||||
|
||||
if arg == "-h" || arg == "--help" {
|
||||
println("Sendkeys example: pipe text into here, and it will type it out after a delay, will press enter for each line")
|
||||
println("Example: uname -a | " + os.Args[0])
|
||||
println("Flags: -n <seconds> (wait this many seconds before sending text)")
|
||||
}
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
func main() {
|
||||
opts := []sendkeys.KBOpt{sendkeys.Noisy}
|
||||
if random {
|
||||
opts = append(opts, sendkeys.Random)
|
||||
println("entropy enabled")
|
||||
}
|
||||
k, err := sendkeys.NewKBWrapWithOptions(sendkeys.Noisy)
|
||||
if err != nil {
|
||||
println(err.Error())
|
||||
return
|
||||
}
|
||||
fmt.Printf("\nSleeping for %d seconds", sleeptime)
|
||||
for n := 0; n != sleeptime; n++ {
|
||||
time.Sleep(1 * time.Second)
|
||||
print(".")
|
||||
}
|
||||
println("Sending keys!")
|
||||
for _, line := range textlines {
|
||||
k.Type(line)
|
||||
k.Enter()
|
||||
}
|
||||
println("\ndone!")
|
||||
}
|
||||
2
go.mod
2
go.mod
@ -7,4 +7,4 @@ require (
|
||||
github.com/micmonay/keybd_event v1.1.1
|
||||
)
|
||||
|
||||
require golang.org/x/sys v0.0.0-20211124211545-fe61309f8881 // indirect
|
||||
require golang.org/x/sys v0.0.0-20211205182925-97ca703d548d // indirect
|
||||
|
||||
4
go.sum
4
go.sum
@ -2,5 +2,5 @@ github.com/eiannone/keyboard v0.0.0-20200508000154-caf4b762e807 h1:jdjd5e68T4R/j
|
||||
github.com/eiannone/keyboard v0.0.0-20200508000154-caf4b762e807/go.mod h1:Xoiu5VdKMvbRgHuY7+z64lhu/7lvax/22nzASF6GrO8=
|
||||
github.com/micmonay/keybd_event v1.1.1 h1:rv7omwXWYL9Lgf3PUq6uBgJI2k1yGkL/GD6dxc6nmSs=
|
||||
github.com/micmonay/keybd_event v1.1.1/go.mod h1:CGMWMDNgsfPljzrAWoybUOSKafQPZpv+rLigt2LzNGI=
|
||||
golang.org/x/sys v0.0.0-20211124211545-fe61309f8881 h1:TyHqChC80pFkXWraUUf6RuB5IqFdQieMLwwCJokV2pc=
|
||||
golang.org/x/sys v0.0.0-20211124211545-fe61309f8881/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||
golang.org/x/sys v0.0.0-20211205182925-97ca703d548d h1:FjkYO/PPp4Wi0EAUOVLxePm7qVW4r4ctbWpURyuOD0E=
|
||||
golang.org/x/sys v0.0.0-20211205182925-97ca703d548d/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||
|
||||
Loading…
Reference in New Issue
Block a user